filter boxes with low score (#177) #37
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: | |
docs-deploy: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest] | |
python: [3.8] | |
steps: | |
- uses: actions/checkout@v2 | |
with: | |
persist-credentials: false | |
- name: Set up Python | |
uses: actions/setup-python@v1 | |
with: | |
python-version: ${{ matrix.python }} | |
architecture: x64 | |
- name: Cache python modules | |
uses: actions/cache@v2 | |
with: | |
path: ~/.cache/pip | |
key: ${{ runner.os }}-python-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }}-docs | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -e ".[docs]" | |
- name: Build documentation | |
run: sphinx-build docs/source docs/build -a -v | |
- name: Documentation sanity check | |
run: test -e docs/build/index.html || exit | |
- name: Install SSH Client 🔑 | |
uses: webfactory/[email protected] | |
with: | |
ssh-private-key: ${{ secrets.SSH_DEPLOY_KEY }} | |
- name: Deploy to Github Pages | |
uses: JamesIves/[email protected] | |
with: | |
BRANCH: gh-pages | |
FOLDER: 'docs/build' | |
COMMIT_MESSAGE: '[skip ci] Documentation updates' | |
CLEAN: true | |
SSH: true |