From 9d754c80b50ae2655a7a5eb3eb92d04a16310251 Mon Sep 17 00:00:00 2001 From: Edward Hartnett <38856240+edwardhartnett@users.noreply.github.com> Date: Thu, 3 Oct 2024 06:09:38 -0600 Subject: [PATCH] Add API documentation to documentation build, turn off documentation warning check (#508) --------- --- .github/workflows/docs.yml | 6 ++++-- doc/UsersGuide/source/conf.py | 1 + doc/UsersGuide/source/index.rst | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 226cde033..494b38644 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,11 +32,13 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme + pip install sphinx sphinxcontrib-bibtex sphinx-rtd-theme numpy matplotlib pandas cartopy pandas cartopy f90nml netCDF4 xarray scipy - name: Build docs run: | cd rrfs-workflow/doc/UsersGuide - sphinx-build -W --keep-going source build + sphinx-apidoc -o source/ ../../ush/ + #sphinx-build -W --keep-going source build + sphinx-build source build - uses: actions/upload-artifact@v4 with: name: rrfs-workflow docs diff --git a/doc/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py index c7f5caf1d..f7b71492b 100644 --- a/doc/UsersGuide/source/conf.py +++ b/doc/UsersGuide/source/conf.py @@ -15,6 +15,7 @@ import os import sys sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../../../ush')) # -- Project information ----------------------------------------------------- diff --git a/doc/UsersGuide/source/index.rst b/doc/UsersGuide/source/index.rst index 1daff7747..276f0499b 100644 --- a/doc/UsersGuide/source/index.rst +++ b/doc/UsersGuide/source/index.rst @@ -11,4 +11,4 @@ RRFS-WORKFLOW Users Guide Quickstart - + modules