Fix docs sphinx-autoapi version and run action on push to main (#54) #4
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
name: Publish Documentation on GitHub Pages | |
on: | |
push: | |
tags: | |
- '*' | |
branches: | |
- main | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
cache: "pip" | |
- name: Dependencies | |
run: | | |
if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi | |
- name: Build Sphinx Documentation | |
run: | | |
sphinx-build docs docs/_build/html | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
if: job.status == 'success' | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/_build/html | |
enable_jekyll: false |