Workflow documentation #26
This file contains 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: Publish documentation online | |
| # build the documentation whenever there are new commits on main | |
| on: | |
| push: | |
| branches: | |
| - main | |
| # Alternative: only build for tags. | |
| # tags: | |
| # - '*' | |
| # security: restrict permissions for CI jobs. | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Build the documentation and upload the static HTML files as an artifact. | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| # ADJUST THIS: install all dependencies (including pdoc) | |
| - run: python -m pip install --upgrade pip | |
| - run: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | |
| - run: python -m pip install -U pip setuptools | |
| - run: pip install wheel | |
| - run: python -m pip install https://files.pythonhosted.org/packages/fa/1e/36d7609e84b50d4a2e5bc43cd5013d9ea885799e5813a1e9cf5bb1afd3f4/scikit_learn-1.2.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | |
| - run: python -m pip install numpy==1.26.4 | |
| - run: python -m pip install pytest | |
| - run: python -m pip install pdoc | |
| # ADJUST THIS: build your documentation into docs/. | |
| # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. | |
| - run: python docs/make.py | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/ | |
| # Deploy the artifact to GitHub pages. | |
| # This is a separate job so that only actions/deploy-pages has the necessary permissions. | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v4 |