Build and publish docs #123
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: Build and publish docs | |
| permissions: | |
| contents: write | |
| on: | |
| workflow_run: | |
| workflows: [Python Tests] | |
| types: | |
| - completed | |
| branches: | |
| - main | |
| jobs: | |
| build-and-publish-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Fetch LFS files | |
| run: git lfs pull | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install poetry | |
| poetry install --with docs | |
| - name: Build Sphinx docs | |
| working-directory: docs | |
| run: | | |
| poetry run make html | |
| touch build/html/.nojekyll | |
| ls -la build/html | sed 's/^/BUILD: /' | |
| - name: Deploy to gh-pages | |
| uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8 | |
| with: | |
| branch: gh-pages | |
| folder: docs/build/html | |
| clean: true | |
| single-commit: true |