Skip to content

Update README.md

Update README.md #93

Workflow file for this run

name: Build and deploy documentation
on:
push:
branches:
- 'main'
pull_request:
env:
WORKFLOWS_DIR: .github/workflows
jobs:
docs:
name: Build and deploy documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # fetches tags, required for version info
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.8
- name: Build library
run: pip install .
- name: Install documentation dependencies
run: |
sudo apt-get install graphviz pandoc
pip install -r docs/requirements.txt
- name: Build documentation
run: ${{ env.WORKFLOWS_DIR }}/build-docs
- name: Deploy documentation
if: ${{ github.event_name == 'push' && (github.ref_name == 'main' || github.ref_name == 'release') }}
uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: docs
FOLDER: docs/_build/html/
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CLEAR_GLOBS_FILE: ${{ env.WORKFLOWS_DIR }}/clear-target-files