Add documentation (claude sonnet 4.6, self review incoming!) #417
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: CI | |
| on: [pull_request, push, workflow_dispatch] | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4.2.2 | |
| - uses: actions/setup-python@v5 | |
| - uses: pre-commit/action@v3.0.1 | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4.2.2 | |
| - name: Setup conda environment | |
| uses: conda-incubator/setup-miniconda@v3 | |
| with: | |
| miniconda-version: "latest" | |
| python-version: ${{ matrix.python-version }} | |
| environment-file: ci/environment-${{ matrix.python-version }}.yml | |
| activate-environment: access-py-telemetry-test | |
| auto-activate-base: false | |
| - name: Install source | |
| shell: bash -l {0} | |
| run: python -m pip install .[dev] | |
| - name: List installed packages | |
| shell: bash -l {0} | |
| run: conda list | |
| - name: Run tests with randomised order | |
| shell: bash -l {0} | |
| run: coverage run -m --source=access_py_telemetry pytest --random-order tests | |
| - name: Generate coverage report | |
| shell: bash -l {0} | |
| run: coverage xml | |
| - name: Upload code coverage | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| token: ${{ secrets.codecov_token }} | |
| files: ./coverage.xml | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4.2.2 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install package and docs dependencies | |
| run: pip install ".[docs]" | |
| - name: Build documentation | |
| run: sphinx-build -W -b html docs docs/_build/html |