Skip to content

docs: restructure sphinx documentation #484

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

Draft
afuetterer wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: restructure sphinx documentation #484

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 9 additions & 8 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,22 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install dependencies
run: |
pip install sphinx furo myst-parser
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: "3.14"
- run: python -m pip install --upgrade pip
- run: python -m pip install sphinx furo myst-parser
- name: Sphinx APIDoc
run: |
sphinx-apidoc -f -o docs/source/ .
sphinx-apidoc --force -o docs/source/ .
- name: Sphinx build
run: |
sphinx-build -b html docs/source/ docs/build/html
sphinx-build --builder html docs/source/ docs/build/html
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@v4
with:
# Upload entire repository
path: './docs/build/html'
Expand Down