[WIP] Add Github workflow: "Pull Request Docs Check"

.github/workflows/pr-docs-check.yml

@@ -0,0 +1,14 @@
+name: "Pull Request Docs Check (SSR Fork)"
+on: 
+- pull_request
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v1
+ - uses: samsrabin/sphinx-action@use-escomp-base-container
+ with:
+ docs-folder: "doc/source"
+ pre-build-command: "git lfs install && git lfs pull --exclude='' --include=''"
+ build-command: "sphinx-build -W --keep-going -n -b html . /home/user/mounted_home/_build"

doc/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS =
+SPHINXOPTS = -W --keep-going -n
 SPHINXBUILD = sphinx-build
 SPHINXPROJ = clmdoc
 SOURCEDIR = source

doc/source/conf.py

@@ -80,7 +80,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -178,7 +178,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
 
 numfig = True
 numfig_format = {'figure': 'Figure %s',

doc/source/lilac/specific-atm-models/wrf-nesting.rst

@@ -50,13 +50,7 @@ A full description of all steps for a WRF-CTSM run are included here.
  Therefore, we are not repeating the steps necessary for building WRF and
  CTSM.
 
-In this example we use a nested domain over the CONUS as shows below:
-
-.. _Figure ctsm-ndown:
-
-.. figure:: ndown_ctsm_diagram.svg
-
- Flowchart for WRF-CTSM one-way nested simulations
+In this example we use a nested domain over the continental United States.
 
 Nested Simulations : Pre-processing (geogrid.exe)
 -------------------------------------------------

doc/source/users_guide/index.rst

@@ -24,7 +24,6 @@
  adding-new-resolutions/index.rst
  running-special-cases/index.rst
  running-single-points/index.rst
- running-PTCLM/index.rst
  trouble-shooting/index.rst
  testing/index.rst
 

doc/source/users_guide/overview/getting-help.rst

@@ -146,9 +146,6 @@ MOSART
 PFT
  Plant Function Type (PFT). A type of vegetation that CLM parameterizes.
 
-PTCLM
- PoinT CLM (PTCLM) a python script that operates on top of CLM for |version| to run single point simulations for CLM.
-
 ROF
  River runOff Model to route flow of surface water over land out to the ocean. |cesmrelease| has two components options for this
  the new model MOSART and previous model RTM.

doc/source/users_guide/overview/introduction.rst

@@ -60,9 +60,7 @@ As a followup to the tools chapter, :ref:`adding-new-resolutions-section` tells
 
 In :ref:`running-special-cases-section`, again for the expert user, we give details on how to do some particularly difficult special cases. For example, we give the protocol for spinning up the |version|-BGC and CLMCN models as well as CLM with dynamic vegetation active (CNDV). We give instructions to do a spinup case from a previous case with Coupler history output for atmospheric forcing. We also give instructions on running both the prognostic crop and irrigation models. Lastly we tell the user how to use the DATM model to send historical CO2 data to CLM.
 
-:ref:`running-single-points` outlines how to do single-point or regional simulations using |version|. This is useful to either compare |version| simulations with point observational stations, such as tower sites (which might include your own atmospheric forcing), or to do quick simulations with CLM for example to test a new parameterization. There are several different ways given on how to perform single-point simulations which range from simple PTS_MODE to more complex where you create all your own datasets, tying into :ref:`using-clm-tools-section` and also :ref:`adding-new-resolutions-section` to add the files into the build-namelist XML database. The PTCLM python script to run single-point simulations was added back in for this release (but it has bugs that don't allow it to work out of the box). CLM4 in CESM1.0.5 has a fully working versions of PTCLM.
-
-Need :ref:`running-PTCLM` blurb...
+:ref:`running-single-points` outlines how to do single-point or regional simulations using |version|. This is useful to either compare |version| simulations with point observational stations, such as tower sites (which might include your own atmospheric forcing), or to do quick simulations with CLM for example to test a new parameterization. There are several different ways given on how to perform single-point simulations which range from simple PTS_MODE to more complex where you create all your own datasets, tying into :ref:`using-clm-tools-section` and also :ref:`adding-new-resolutions-section` to add the files into the build-namelist XML database.
 
 :ref:`troubleshooting-index` gives some guidance on trouble-shooting problems when using |version|. It doesn't cover all possible problems with CLM, but gives you some guidelines for things that can be done for some common problems.