Skip to content

Sphinx build

Sphinx build #24

Workflow file for this run

name: Sphinx build
on:
workflow_dispatch:
inputs:
doc_format:
description: 'Extension to parse docstrings'
required: true
default: 'numpydoc'
type: choice
options:
- numpydoc
- napoleon
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.8'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install -U pip
pip install -r docs/requirements.txt
- name: Build HTML
run: make html
working-directory: docs
env:
doc_format: ${{ inputs.doc_format }}
- name: Upload artifacts
uses: actions/upload-pages-artifact@v1
with:
path: docs/_build/html/
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1