Docs #7
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 Netz AG and contributors | |
# SPDX-License-Identifier: CC0-1.0 | |
name: Docs | |
on: | |
push: | |
branches: ["main"] | |
jobs: | |
sphinx: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v2 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: "3.8" | |
- name: Upgrade pip | |
run: | | |
python -m pip install -U pip | |
- name: Install dependencies | |
run: | | |
python -m pip install '.[docs]' | |
- name: Auto-generate APIDOC sources | |
run: |- | |
sphinx-apidoc --output-dir docs/source/code --force . | |
- name: Create docs | |
run: | | |
make -C docs html | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
force_orphan: true | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/build/html |