Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation

on:
push:
branches:
- 'master'
pull_request:
types:
- closed
branches:
- 'master'

permissions:
contents: write

concurrency:
group: ${{ github.ref }}
cancel-in-progress: true

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser furo sphinx_subfigure numpydoc
pip install -e .

- name: Generate documentation figures
run: |
python docs/documentation_figures.py

- name: Sphinx build
run: |
sphinx-build docs/source _build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
1,348 changes: 0 additions & 1,348 deletions docs/documentation_figures.ipynb

This file was deleted.

Loading
Loading