Add API documentation to documentation build, turn off documentation …

…warning check (#508) ---------
NOAA-EMC · Oct 3, 2024 · 9d754c8 · 9d754c8
1 parent 273e5ee
commit 9d754c8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git 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
@@ -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
@@ -11,4 +11,4 @@ RRFS-WORKFLOW Users Guide
 
 
  Quickstart
-
+ modules