Skip to content

Dev branch should build documentation correctly now #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomasthaddeus merged 3 commits into from
May 7, 2024
Merged

Dev branch should build documentation correctly now #23

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
103b6c1
update docs build
thomasthaddeus May 7, 2024
d2cda95
update docs build
thomasthaddeus May 7, 2024
ac54c41
Merge pull request #22 from thomasthaddeus/main
thomasthaddeus May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- main
paths:
- 'docs/**'
workflow_dispatch:

jobs:
build:
Expand All @@ -19,22 +20,26 @@ jobs:
with:
python-version: '3.11'

- name: Cache Python packages
uses: actions/cache@v4.0.2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-

- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt

- name: List directory structure
run: |
ls -R docs/

- name: Build Documentation with Sphinx
run: |
cd docs
make html
sphinx-build -M html docs/source/ docs/build/
env:
READTHEDOCS: 'True'

# Uncomment below to upload artifacts if needed
# - name: Upload Artifacts
# uses: actions/upload-artifact@v4
# with:
Expand Down