Skip to content

Add CI workflow which does documentation build #1

Add CI workflow which does documentation build

Add CI workflow which does documentation build #1

Workflow file for this run

# This workflow will build the documentation.
#
# Edward Hartnett, 9/16/24
name: docs
on:
push:
branches: [ "dev-sci" ]
pull_request:
branches: [ "dev-sci" ]
permissions:
contents: read
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
with:
path: rrfs-workflow
submodules: true
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme
- name: Build docs
run: |
cd rrfs-workflow/doc/UsersGuide
sphinx-build -b html source build
- uses: actions/upload-artifact@v4
with:
name: docs
path: |
rrfs-workflow/doc/UsersGuide/build