Skip to content

Documentation improvements #1

Documentation improvements

Documentation improvements #1

Workflow file for this run

# This file was modified from https://github.com/ammaraskar/sphinx-action-test/blob/master/.github/workflows/pull_request.yml
name: Pull Request Docs Check
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
# Standard drop-in approach that should work for most people.
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
# Example of using a custom build-command.
#- uses: ammaraskar/sphinx-action@master
# with:
# build-command: "sphinx-build -b html . _build"
# docs-folder: "docs2/"
## Grabbing custom dependencies and building as a pdf.
#- uses: ammaraskar/sphinx-action@master
# with:
# pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
# build-command: "make latexpdf"
# docs-folder: "docs2/"
# Great extra actions to compose with:
# Create an artifact of the html output.
- uses: actions/upload-artifact@v4
with:
name: DocumentationHTML
path: docs/build/html/