Merge pull request #3 from DSD-DBS/msg2cap #17
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: | |
workflow_dispatch: | |
push: | |
branches: [master] | |
jobs: | |
sphinx: | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
cache: pip | |
cache-dependency-path: pyproject.toml | |
python-version: "3.12" | |
- name: Upgrade pip | |
run: python -m pip install -U pip | |
- name: Install dependencies | |
run: | | |
sudo apt-get install -y pandoc | |
python -m pip install '.[docs]' | |
- name: Auto-generate APIDOC sources | |
run: make -C docs apidoc | |
- name: Create docs | |
run: make -C docs html | |
- name: Deploy | |
if: github.ref == 'refs/heads/master' | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
force_orphan: true | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/build/html |