Merge pull request #113 from IMMM-SFA/bugfix/sphinx-version-error #2
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: docs | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install pandoc | |
run: | | |
sudo apt-get update -y && sudo apt-get install -y pandoc | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.9' | |
- name: Update pip and install python dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install .[dev] | |
- name: Build html docs | |
working-directory: 'docs/' | |
run: | | |
make html | |
- name: Commit documentation changes | |
run: | | |
cd docs/build/html | |
git init | |
git add -A | |
git config --local user.email "[email protected]" | |
git config --local user.name "GitHub Action" | |
git commit -m 'deploy' -a || true | |
- name: Push changes to gh-pages | |
uses: ad-m/github-push-action@master | |
with: | |
branch: gh-pages | |
directory: docs/build/html | |
force: true | |
github_token: ${{ secrets.GITHUB_TOKEN }} |