Skip to content

Bootstrap docs from template #4

Bootstrap docs from template

Bootstrap docs from template #4

Workflow file for this run

name: "Build docs using sphinx"
on:
push:
branches:
- main
pull_request:
# also run on 'closed' to clean up the github pages dir
types:
- opened
- reopened
- synchronize
- closed
concurrency: preview-${{ github.ref }}
jobs:
docs:
name: "Build Docs"
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
# - name: "Set up Python"
# uses: actions/setup-python@v5
# with:
# python-version: 3.12
# - name: "Install DSO"
# run: pip install '.[doc]'
# - name: "Build docs with Sphinx"
# run: cd docs && make html
- name: Build Sphinx docs
uses: ammaraskar/sphinx-action@master
if: github.event.action != 'closed'
with:
pre-build-command: pip install -e '.[doc]'
docs-folder: "docs/"
- name: Deploy preview
if: github.event_name == 'pull_request'
uses: rossjrw/pr-preview-action@v1
with:
source-dir: docs/_build/html
- name: Deploy docs
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
branch: gh-pages
clean-exclude: pr-preview/
force: false