baseline doc updates #21
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs | |
| on: | |
| workflow_dispatch: | |
| workflow_call: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Add python requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install tox | |
| - name: Build docs | |
| run: | | |
| tox -e ldocs | |
| tox -e docs | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: ApiDocsHTML | |
| path: "docs/_build/html/" | |
| - name: set nojekyll for github | |
| run: | | |
| sudo touch docs/_build/html/.nojekyll | |
| - name: Deploy docs to gh-pages | |
| if: ${{ github.event_name == 'push' }} | |
| uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8 # v4.7.3 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages | |
| folder: docs/_build/html/ | |
| single-commit: true |