Skip to content
documentation

Update docs workflow #2

Sign in to view logs

Update docs workflow

Update docs workflow #2

Workflow file for this run

.github/workflows/documentation.yml at 4c4909e
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-material sphinx-autodoc-typehints myst_parser
- name: Sphinx build
run: |
sphinx-build sphinx _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true