docs: explain electricitymaps_api_token and query behaviour #127
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: Build Documentation | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: [master] | |
| paths: | |
| - "docs/**" | |
| - "mkdocs.yml" | |
| - "pyproject.toml" | |
| - "uv.lock" | |
| - "scripts/check_docs_links.py" | |
| - ".github/workflows/build-docs.yml" | |
| pull_request: | |
| branches: [master] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0 | |
| with: | |
| version: "latest" | |
| - name: Set up Python | |
| run: uv python install 3.11 | |
| - name: Install dependencies | |
| run: uv sync --group doc | |
| - name: Build docs | |
| run: | | |
| set -euo pipefail | |
| uv run zensical build -f mkdocs.yml --clean 2>&1 | tee docs_build.log | |
| if grep -Ei "\b(error|failed|traceback|exception)\b" docs_build.log >/dev/null; then | |
| echo "Documentation build produced errors; failing workflow." | |
| exit 1 | |
| fi | |
| - name: Check documentation links (site/) | |
| run: uv run python scripts/check_docs_links.py site |