[develop]: Update doc requirements and add logo (ufs-community#1018)

* Specify a minimum version of Sphinx in requirements.in * Update requirements.txt based on requirements.in for a full list of dependencies. This will ensure uniform documentation builds across platforms. * Add UFS logo to documentation. * Rename docs directory to doc for NCO compliance. * Slightly darken blue sidebar background to meet WCAG AA text/background contrast standards for large text. --------- Co-authored-by: michael.lueken <Michael.Lueken@noaa.gov>
NOAA-EPIC · Feb 21, 2024 · 6d3ebfb · 6d3ebfb
1 parent b3f1295
commit 6d3ebfb
Show file tree

Hide file tree

Showing 48 changed files with 121 additions and 41 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,7 +17,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/UsersGuide/source/conf.py
+   configuration: doc/UsersGuide/source/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -26,7 +26,7 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/UsersGuide/requirements.txt
+   - requirements: doc/UsersGuide/requirements.txt
 
 submodules:
    include:

diff --git a/docs/INSTALL → doc/INSTALL b/docs/INSTALL → doc/INSTALL
diff --git a/docs/RUNTIME → doc/RUNTIME b/docs/RUNTIME → doc/RUNTIME
diff --git a/docs/UsersGuide/Makefile → doc/UsersGuide/Makefile b/docs/UsersGuide/Makefile → doc/UsersGuide/Makefile
diff --git a/docs/UsersGuide/README → doc/UsersGuide/README b/docs/UsersGuide/README → doc/UsersGuide/README
diff --git a/docs/UsersGuide/make.bat → doc/UsersGuide/make.bat b/docs/UsersGuide/make.bat → doc/UsersGuide/make.bat
@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/docs/UsersGuide/requirements.txt → doc/UsersGuide/requirements.in b/docs/UsersGuide/requirements.txt → doc/UsersGuide/requirements.in
@@ -1,3 +1,3 @@
-sphinxcontrib-bibtex
+sphinx>=6.0.0
 sphinx_rtd_theme
-docutils==0.16
+sphinxcontrib-bibtex
diff --git a/doc/UsersGuide/requirements.txt b/doc/UsersGuide/requirements.txt
@@ -0,0 +1,76 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+alabaster==0.7.16
+    # via sphinx
+babel==2.14.0
+    # via sphinx
+certifi==2024.2.2
+    # via requests
+charset-normalizer==3.3.2
+    # via requests
+docutils==0.19
+    # via
+    #   pybtex-docutils
+    #   sphinx
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-bibtex
+idna==3.6
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.3
+    # via sphinx
+latexcodec==2.0.1
+    # via pybtex
+markupsafe==2.1.5
+    # via jinja2
+packaging==23.2
+    # via sphinx
+pybtex==0.24.0
+    # via
+    #   pybtex-docutils
+    #   sphinxcontrib-bibtex
+pybtex-docutils==1.0.3
+    # via sphinxcontrib-bibtex
+pygments==2.17.2
+    # via sphinx
+pyyaml==6.0.1
+    # via pybtex
+requests==2.31.0
+    # via sphinx
+six==1.16.0
+    # via
+    #   latexcodec
+    #   pybtex
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==7.2.6
+    # via
+    #   -r requirements.in
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-bibtex
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==2.0.0
+    # via -r requirements.in
+sphinxcontrib-applehelp==1.0.8
+    # via sphinx
+sphinxcontrib-bibtex==2.5.0
+    # via -r requirements.in
+sphinxcontrib-devhelp==1.0.6
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.5
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.7
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.10
+    # via sphinx
+urllib3==2.2.0
+    # via requests
diff --git a/...ide/source/BackgroundInfo/CCPPUpdates.rst → ...ide/source/BackgroundInfo/CCPPUpdates.rst b/...ide/source/BackgroundInfo/CCPPUpdates.rst → ...ide/source/BackgroundInfo/CCPPUpdates.rst
diff --git a/...uide/source/BackgroundInfo/Components.rst → ...uide/source/BackgroundInfo/Components.rst b/...uide/source/BackgroundInfo/Components.rst → ...uide/source/BackgroundInfo/Components.rst
diff --git a/...de/source/BackgroundInfo/Introduction.rst → ...de/source/BackgroundInfo/Introduction.rst b/...de/source/BackgroundInfo/Introduction.rst → ...de/source/BackgroundInfo/Introduction.rst
diff --git a/...urce/BackgroundInfo/TechnicalOverview.rst → ...urce/BackgroundInfo/TechnicalOverview.rst b/...urce/BackgroundInfo/TechnicalOverview.rst → ...urce/BackgroundInfo/TechnicalOverview.rst
diff --git a/...sersGuide/source/BackgroundInfo/index.rst → ...sersGuide/source/BackgroundInfo/index.rst b/...sersGuide/source/BackgroundInfo/index.rst → ...sersGuide/source/BackgroundInfo/index.rst
diff --git a/...ide/source/BuildingRunningTesting/AQM.rst → ...ide/source/BuildingRunningTesting/AQM.rst b/...ide/source/BuildingRunningTesting/AQM.rst → ...ide/source/BuildingRunningTesting/AQM.rst
diff --git a/...ource/BuildingRunningTesting/BuildSRW.rst → ...ource/BuildingRunningTesting/BuildSRW.rst b/...ource/BuildingRunningTesting/BuildSRW.rst → ...ource/BuildingRunningTesting/BuildSRW.rst
diff --git a/...ingRunningTesting/ContainerQuickstart.rst → ...ingRunningTesting/ContainerQuickstart.rst b/...ingRunningTesting/ContainerQuickstart.rst → ...ingRunningTesting/ContainerQuickstart.rst
diff --git a/...ildingRunningTesting/DefaultVarsTable.rst → ...ildingRunningTesting/DefaultVarsTable.rst b/...ildingRunningTesting/DefaultVarsTable.rst → ...ildingRunningTesting/DefaultVarsTable.rst
diff --git a/...rce/BuildingRunningTesting/Quickstart.rst → ...rce/BuildingRunningTesting/Quickstart.rst b/...rce/BuildingRunningTesting/Quickstart.rst → ...rce/BuildingRunningTesting/Quickstart.rst
diff --git a/.../source/BuildingRunningTesting/RunSRW.rst → .../source/BuildingRunningTesting/RunSRW.rst b/.../source/BuildingRunningTesting/RunSRW.rst → .../source/BuildingRunningTesting/RunSRW.rst
diff --git a/...ource/BuildingRunningTesting/Tutorial.rst → ...ource/BuildingRunningTesting/Tutorial.rst b/...ource/BuildingRunningTesting/Tutorial.rst → ...ource/BuildingRunningTesting/Tutorial.rst
diff --git a/...source/BuildingRunningTesting/VXCases.rst → ...source/BuildingRunningTesting/VXCases.rst b/...source/BuildingRunningTesting/VXCases.rst → ...source/BuildingRunningTesting/VXCases.rst
diff --git a/...urce/BuildingRunningTesting/WE2Etests.rst → ...urce/BuildingRunningTesting/WE2Etests.rst b/...urce/BuildingRunningTesting/WE2Etests.rst → ...urce/BuildingRunningTesting/WE2Etests.rst
diff --git a/...e/source/BuildingRunningTesting/index.rst → ...e/source/BuildingRunningTesting/index.rst b/...e/source/BuildingRunningTesting/index.rst → ...e/source/BuildingRunningTesting/index.rst
diff --git a/...CustomizingTheWorkflow/ConfigWorkflow.rst → ...CustomizingTheWorkflow/ConfigWorkflow.rst b/...CustomizingTheWorkflow/ConfigWorkflow.rst → ...CustomizingTheWorkflow/ConfigWorkflow.rst
diff --git a/...CustomizingTheWorkflow/DefineWorkflow.rst → ...CustomizingTheWorkflow/DefineWorkflow.rst b/...CustomizingTheWorkflow/DefineWorkflow.rst → ...CustomizingTheWorkflow/DefineWorkflow.rst
diff --git a/...stomizingTheWorkflow/InputOutputFiles.rst → ...stomizingTheWorkflow/InputOutputFiles.rst b/...stomizingTheWorkflow/InputOutputFiles.rst → ...stomizingTheWorkflow/InputOutputFiles.rst
diff --git a/...ource/CustomizingTheWorkflow/LAMGrids.rst → ...ource/CustomizingTheWorkflow/LAMGrids.rst b/...ource/CustomizingTheWorkflow/LAMGrids.rst → ...ource/CustomizingTheWorkflow/LAMGrids.rst
diff --git a/...e/CustomizingTheWorkflow/TemplateVars.rst → ...e/CustomizingTheWorkflow/TemplateVars.rst b/...e/CustomizingTheWorkflow/TemplateVars.rst → ...e/CustomizingTheWorkflow/TemplateVars.rst
diff --git a/...e/source/CustomizingTheWorkflow/index.rst → ...e/source/CustomizingTheWorkflow/index.rst b/...e/source/CustomizingTheWorkflow/index.rst → ...e/source/CustomizingTheWorkflow/index.rst
diff --git a/docs/UsersGuide/source/Reference/FAQ.rst → doc/UsersGuide/source/Reference/FAQ.rst b/docs/UsersGuide/source/Reference/FAQ.rst → doc/UsersGuide/source/Reference/FAQ.rst
diff --git a/.../UsersGuide/source/Reference/Glossary.rst → doc/UsersGuide/source/Reference/Glossary.rst b/.../UsersGuide/source/Reference/Glossary.rst → doc/UsersGuide/source/Reference/Glossary.rst
diff --git a/...sersGuide/source/Reference/RocotoInfo.rst → ...sersGuide/source/Reference/RocotoInfo.rst b/...sersGuide/source/Reference/RocotoInfo.rst → ...sersGuide/source/Reference/RocotoInfo.rst
diff --git a/docs/UsersGuide/source/Reference/index.rst → doc/UsersGuide/source/Reference/index.rst b/docs/UsersGuide/source/Reference/index.rst → doc/UsersGuide/source/Reference/index.rst
diff --git a/docs/UsersGuide/source/SSHIntro.rst → doc/UsersGuide/source/SSHIntro.rst b/docs/UsersGuide/source/SSHIntro.rst → doc/UsersGuide/source/SSHIntro.rst
diff --git a/docs/UsersGuide/source/_static/custom.css → doc/UsersGuide/source/_static/custom.css b/docs/UsersGuide/source/_static/custom.css → doc/UsersGuide/source/_static/custom.css
diff --git a/...sGuide/source/_static/theme_overrides.css → ...sGuide/source/_static/theme_overrides.css b/...sGuide/source/_static/theme_overrides.css → ...sGuide/source/_static/theme_overrides.css
@@ -17,5 +17,8 @@
 
 }
 
-
+/* Darken navbar blue background for contrast with logo */
+.wy-side-nav-search, .wy-nav-top {
+   background: #2779B0;
+}
 
diff --git a/docs/UsersGuide/source/_templates/.gitignore → doc/UsersGuide/source/_templates/.gitignore b/docs/UsersGuide/source/_templates/.gitignore → doc/UsersGuide/source/_templates/.gitignore
diff --git a/docs/UsersGuide/source/conf.py → doc/UsersGuide/source/conf.py b/docs/UsersGuide/source/conf.py → doc/UsersGuide/source/conf.py
@@ -28,6 +28,7 @@
 version = 'develop'
 # The full version, including alpha/beta/rc tags
 release = 'Develop Branch Documentation'
+html_logo = "https://github.com/ufs-community/ufs/wiki/images/ufs-epic-logo.png"
 
 numfig = True
 
@@ -131,7 +132,7 @@
 # html_theme_options = {}
 html_theme_options = {
     "body_max_width": "none", 
-    'navigation_depth': 6,
+    "navigation_depth": 6,
     }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/UsersGuide/source/index.rst → doc/UsersGuide/source/index.rst b/docs/UsersGuide/source/index.rst → doc/UsersGuide/source/index.rst
diff --git a/docs/UsersGuide/source/references.bib → doc/UsersGuide/source/references.bib b/docs/UsersGuide/source/references.bib → doc/UsersGuide/source/references.bib
diff --git a/...sGuide/source/tables/SRW_NATLEV_table.csv → ...sGuide/source/tables/SRW_NATLEV_table.csv b/...sGuide/source/tables/SRW_NATLEV_table.csv → ...sGuide/source/tables/SRW_NATLEV_table.csv
diff --git a/...sGuide/source/tables/SRW_NATLEV_table.rst → ...sGuide/source/tables/SRW_NATLEV_table.rst b/...sGuide/source/tables/SRW_NATLEV_table.rst → ...sGuide/source/tables/SRW_NATLEV_table.rst
diff --git a/...sGuide/source/tables/SRW_PRSLEV_table.csv → ...sGuide/source/tables/SRW_PRSLEV_table.csv b/...sGuide/source/tables/SRW_PRSLEV_table.csv → ...sGuide/source/tables/SRW_PRSLEV_table.csv
diff --git a/...sGuide/source/tables/SRW_PRSLEV_table.rst → ...sGuide/source/tables/SRW_PRSLEV_table.rst b/...sGuide/source/tables/SRW_PRSLEV_table.rst → ...sGuide/source/tables/SRW_PRSLEV_table.rst
diff --git a/docs/UsersGuide/source/tables/Tests.csv → doc/UsersGuide/source/tables/Tests.csv b/docs/UsersGuide/source/tables/Tests.csv → doc/UsersGuide/source/tables/Tests.csv
diff --git a/docs/UsersGuide/source/tables/Tests.rst → doc/UsersGuide/source/tables/Tests.rst b/docs/UsersGuide/source/tables/Tests.rst → doc/UsersGuide/source/tables/Tests.rst
diff --git a/...sersGuide/source/tables/fix_file_list.rst → ...sersGuide/source/tables/fix_file_list.rst b/...sersGuide/source/tables/fix_file_list.rst → ...sersGuide/source/tables/fix_file_list.rst
diff --git a/docs/UsersGuide/source/tables/.DS_Store b/docs/UsersGuide/source/tables/.DS_Store