Skip to content

Docs

Docs #32

Workflow file for this run

name: Docs
on:
push:
branches:
- main
paths:
- "src/**"
- "docs/**"
- "!**.md"
- "!.github/workflows/ci.yml"
pull_request:
paths-ignore:
- "**.md"
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install numpydoc m2r2
pip install -e .
pip install sphinx sphinx_rtd_theme
- name: Build docs with sphinx
run: sphinx-build -b html docs docs/_build/html
- name: Deploy documentation to gh-pages branch
uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: gh-pages
FOLDER: docs/_build/html
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}