Add note to CLI #932
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: Docs | |
| on: | |
| pull_request: | |
| push: | |
| branches: [main] | |
| tags: | |
| - '*' | |
| env: | |
| COMMIT_EMAIL: ben.jeffery.well+adminbot@gmail.com | |
| MAKE_TARGET: all | |
| OWNER: tskit-dev | |
| REPO: tsinfer | |
| jobs: | |
| build-deploy-docs: | |
| name: Docs | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Cancel Previous Runs | |
| uses: styfle/cancel-workflow-action@0.12.1 | |
| with: | |
| access_token: ${{ github.token }} | |
| - uses: actions/checkout@v4.2.2 | |
| with: | |
| submodules: true | |
| - uses: actions/setup-python@v5.3.0 | |
| with: | |
| python-version: "3.11" | |
| cache: "pip" | |
| - name: Install deps (one by one to avoid conflict errors) | |
| run: | | |
| pip install --upgrade pip wheel | |
| pip install -r requirements/CI-docs/requirements.txt | |
| sudo apt-get install -y tabix | |
| - name: Build C module | |
| if: env.MAKE_TARGET | |
| run: | | |
| make $MAKE_TARGET | |
| - name: Build Docs | |
| run: | | |
| cd docs && make dist | |
| - name: Trigger docs site rebuild | |
| if: github.ref == 'refs/heads/main' | |
| run: | | |
| curl -X POST https://api.github.com/repos/tskit-dev/tskit-site/dispatches \ | |
| -H 'Accept: application/vnd.github.everest-preview+json' \ | |
| -u AdminBot-tskit:${{ secrets.ADMINBOT_TOKEN }} \ | |
| --data '{"event_type":"build-docs"}' |