update guides for inserting terminal groups #21
Workflow file for this run
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: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| paths: | |
| - docs/** | |
| - pyproject.toml | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| permissions: "write-all" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| cache: "pip" | |
| cache-dependency-path: | | |
| pyproject.toml | |
| requirements*.txt | |
| - name: Get pip cache dir | |
| id: pip-cache | |
| run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT | |
| - name: Cache pip dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| key: ${{ runner.os }}-pip-docs-${{ hashFiles('pyproject.toml', 'requirements*.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip-docs- | |
| - name: Cache mkdocs | |
| uses: actions/cache@v3 | |
| with: | |
| path: .cache/mkdocs | |
| key: ${{ runner.os }}-mkdocs-${{ hashFiles('docs/**') }} | |
| restore-keys: | | |
| ${{ runner.os }}-mkdocs- | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip wheel setuptools | |
| pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-jupyter | |
| pip install -e ".[docs]" | |
| - name: Build docs | |
| run: mkdocs build | |
| - name: Deploy docs | |
| run: mkdocs gh-deploy --force | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' |