Merge pull request #224 from icecube/fix-#223 #829
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 builds sphinx documentation and deploys static html files to the gh-pages branch. | |
# Based on https://github.com/marketplace/actions/github-pages-action#%EF%B8%8F-static-site-generators-with-python | |
name: Documentation | |
on: | |
push: | |
branches: | |
- master | |
- docs | |
pull_request: | |
branches: | |
- master | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: Setup Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: '3.8' | |
- name: Upgrade pip | |
run: | | |
# install pip=>20.1 to use "pip cache dir" | |
python3 -m pip install --upgrade pip | |
- name: Get pip cache dir | |
id: pip-cache | |
run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT | |
- name: Cache dependencies | |
uses: actions/cache@v3 | |
with: | |
path: ${{ steps.pip-cache.outputs.dir }} | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: Install dependencies | |
run: python3 -m pip install -r ./doc/sphinx/requirements.txt | |
- name: Install pandoc | |
run: sudo apt-get -y install pandoc | |
- name: Build documentation | |
run: | | |
cd ./doc/sphinx | |
make html-multiversion | |
cp _assets/gh-pages-redirect.html _build/index.html | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./doc/sphinx/_build | |
force_orphan: true |