Skip to content

docs: Updates CONTRIBUTING & README (#220) #80

docs: Updates CONTRIBUTING & README (#220)

docs: Updates CONTRIBUTING & README (#220) #80

Workflow file for this run

name: docs
on:
push:
branches: main
jobs:
docs-deploy:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
python: [3.9]
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: cd docs && bash build.sh
- 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