Merge pull request #54 from HaoZeke/fix/52-bound-setup-cache #35
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: Documentation | |
| on: | |
| pull_request: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| env: | |
| PDM_BUILD_SCM_VERSION: "0.2.2.dev0" | |
| jobs: | |
| build_docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install package and docs deps | |
| run: | | |
| python -m pip install -U pip setuptools wheel | |
| python -m pip install -e ".[docs]" | |
| - name: Sphinx HTML | |
| run: sphinx-build -b html docs/source docs/build/html | |
| - name: Upload documentation artifact (PR preview) | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation | |
| path: docs/build/html | |
| retention-days: 14 | |
| - name: Lychee on built HTML | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| args: >- | |
| --config lychee.toml | |
| --no-progress | |
| docs/build/html | |
| fail: false |