docs: add GitBook setup, fix broken links, and generate API reference #11
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: Tests for Docs | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'src/**' | |
| - 'tests/**' | |
| - 'docs/**' | |
| - '.github/workflows/**' | |
| - 'pyproject.toml' | |
| pull_request: | |
| paths: | |
| - 'src/**' | |
| - 'tests/**' | |
| - 'docs/**' | |
| - '.github/workflows/**' | |
| - 'pyproject.toml' | |
| workflow_dispatch: | |
| jobs: | |
| run-docs-tests: | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: 3.13 | |
| activate-environment: true | |
| - run: uv sync --group tests --extra all | |
| - run: pytest tests/docs -v --cov --cov-report=xml | |
| - name: Upload coverage reports to Codecov | |
| if: always() | |
| uses: codecov/codecov-action@v6 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} |