fix docs: mkdocstrings paths to src for bt_api_py source #14
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: Deploy Docs | |
| on: | |
| push: | |
| branches: [master, main] | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - 'mkdocs.yml' | |
| - '.readthedocs.yaml' | |
| - 'docs/requirements.txt' | |
| - '.github/workflows/docs.yml' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - 'mkdocs.yml' | |
| - 'docs/requirements.txt' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.11' | |
| cache: pip | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Install doc dependencies | |
| run: pip install --upgrade pip -r docs/requirements.txt | |
| - name: Install package (needed by mkdocstrings) | |
| run: pip install --no-build-isolation -e . || pip install --no-deps -e . | |
| - name: Build docs (strict) | |
| run: mkdocs build --strict | |
| - name: Upload artifact | |
| if: github.event_name != 'pull_request' | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: site/ | |
| deploy: | |
| if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main') | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |