Skip to content

chore: update Sphinx build workflow to remove unnecessary dependencie… #10

chore: update Sphinx build workflow to remove unnecessary dependencie…

chore: update Sphinx build workflow to remove unnecessary dependencie… #10

Workflow file for this run

name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-apidoc -o docs/ . && sphinx-build docs/ docs/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build
force_orphan: true