move to zensical for docs #2
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: "📚 Documentation Builder" | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - docs | |
| paths: | |
| - .github/workflows/docs.yml | |
| - docs/**/* | |
| tags: | |
| - "*" | |
| pull_request: | |
| branches: | |
| - main | |
| paths: | |
| - .github/workflows/docs.yml | |
| - docs/**/* | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Get source code | |
| uses: actions/checkout@v6 | |
| - uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.12' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install -e .[docs] | |
| - name: Build documentation | |
| run: zensical build -f docs/mkdocs.yml --strict | |
| - uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: docs/site | |
| deploy: | |
| needs: build-docs | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name != 'pull_request' && github.ref_type != 'tag' }} | |
| environment: | |
| name: github-pages | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |