Skip to content

Commit

Permalink
Create build sphinx github action workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenTorrisi-TRI committed Aug 14, 2024
1 parent 92f5dcc commit b4a411b
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/build_sphinx.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Build Sphinx Documentation

on:
push:
branches:
- main # Adjust this to your main branch
pull_request:
branches:
- main # Optionally build on PRs to the main branch

jobs:
build-docs:
runs-on: ubuntu-latest

steps:
- name: Check out the repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.8' # Specify your required Python version

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
# Add other Sphinx dependencies here
- name: Build the documentation
run: |
cd docs
make html
- name: Upload Documentation
uses: actions/upload-artifact@v3
with:
name: sphinx-docs
path: docs/build/html

0 comments on commit b4a411b

Please sign in to comment.