docs: Add notebook tutorials section into docs #129
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
# Copyright DB InfraGO AG and contributors | |
# SPDX-License-Identifier: CC0-1.0 | |
name: Docs | |
on: | |
pull_request: | |
push: | |
branches: ["main"] | |
workflow_dispatch: | |
jobs: | |
sphinx: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v5 | |
with: | |
cache: pip | |
cache-dependency-path: pyproject.toml | |
python-version: "3.12" | |
- name: Install system-level dependencies | |
run: sudo apt-get install -y pandoc | |
- name: Upgrade pip | |
run: | | |
python -m pip install -U pip | |
- name: Install dependencies | |
run: | | |
python -m pip install '.[docs]' | |
- name: Create docs | |
env: | |
SPHINXOPTS: ${{ github.ref != 'refs/heads/main' && '-W' || '' }} | |
run: make -C docs html | |
- name: Upload built docs as artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: Documentation | |
path: docs/build/html | |
if-no-files-found: error | |
retention-days: 5 | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
force_orphan: true | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/build/html |