Update doc files and set up docu workflow to deploy sphinx to gh page… #2
Workflow file for this run
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
# This workflow will install Python dependencies, produce the sphinx documentation, and publish it to GitHub pages | |
name: documentation | |
on: | |
push: | |
branches: | |
- 'master' | |
tags: | |
- '*' | |
jobs: | |
documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python 3.10 | |
uses: actions/setup-python@v1 | |
with: | |
python-version: '3.10' | |
- name: Install dependencies | |
run: | | |
python -m pip install "pip<21.3" | |
pip install .[develop] | |
- name: Build the docs | |
run: | | |
sphinx-apidoc -f -o docs/source pisa | |
cd docs && make html | |
- name: Deploy to gh pages | |
uses: peaceiris/actions-gh-pages@v3.9.2 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/build/html |