Skip to content

Replacing Sphinx Build Action - with simpler approach #2779

Replacing Sphinx Build Action - with simpler approach

Replacing Sphinx Build Action - with simpler approach #2779

Workflow file for this run

# Github Actions workflow to generate documentation
# Uses the following shared task definitions:
# - (checkout, upload artifact) from Github
# - sphinx-action maintained by @ammaraskar
name: Sphinx build
# Controls when the action will run.
# Triggers the workflow on push or pull request events.
on:
- push
- pull_request
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Create Sphinx log file
run: mkdir -p /tmp && touch /tmp/sphinx-log
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "doc/"
pre-build-command: pip3 install sphinx_markdown_builder
- uses: actions/upload-artifact@v3
with:
name: UserGuideHTML
path: "doc/_build/html/"