diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e0987f8926..b6afe96c93 100644 --- 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 b/doc/INSTALL similarity index 100% rename from docs/INSTALL rename to doc/INSTALL diff --git a/docs/RUNTIME b/doc/RUNTIME similarity index 100% rename from docs/RUNTIME rename to doc/RUNTIME diff --git a/docs/UsersGuide/Makefile b/doc/UsersGuide/Makefile similarity index 100% rename from docs/UsersGuide/Makefile rename to doc/UsersGuide/Makefile diff --git a/docs/UsersGuide/README b/doc/UsersGuide/README similarity index 100% rename from docs/UsersGuide/README rename to doc/UsersGuide/README diff --git a/docs/UsersGuide/make.bat b/doc/UsersGuide/make.bat similarity index 95% rename from docs/UsersGuide/make.bat rename to doc/UsersGuide/make.bat index 543c6b13b4..4d9eb83d9f 100644 --- a/docs/UsersGuide/make.bat +++ b/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 b/doc/UsersGuide/requirements.in similarity index 73% rename from docs/UsersGuide/requirements.txt rename to doc/UsersGuide/requirements.in index 7be32f526d..26c778f4aa 100644 --- a/docs/UsersGuide/requirements.txt +++ b/doc/UsersGuide/requirements.in @@ -1,3 +1,3 @@ -sphinxcontrib-bibtex +sphinx>=6.0.0 sphinx_rtd_theme -docutils==0.16 \ No newline at end of file +sphinxcontrib-bibtex diff --git a/doc/UsersGuide/requirements.txt b/doc/UsersGuide/requirements.txt new file mode 100644 index 0000000000..60c67635ea --- /dev/null +++ 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/docs/UsersGuide/source/BackgroundInfo/CCPPUpdates.rst b/doc/UsersGuide/source/BackgroundInfo/CCPPUpdates.rst similarity index 100% rename from docs/UsersGuide/source/BackgroundInfo/CCPPUpdates.rst rename to doc/UsersGuide/source/BackgroundInfo/CCPPUpdates.rst diff --git a/docs/UsersGuide/source/BackgroundInfo/Components.rst b/doc/UsersGuide/source/BackgroundInfo/Components.rst similarity index 100% rename from docs/UsersGuide/source/BackgroundInfo/Components.rst rename to doc/UsersGuide/source/BackgroundInfo/Components.rst diff --git a/docs/UsersGuide/source/BackgroundInfo/Introduction.rst b/doc/UsersGuide/source/BackgroundInfo/Introduction.rst similarity index 100% rename from docs/UsersGuide/source/BackgroundInfo/Introduction.rst rename to doc/UsersGuide/source/BackgroundInfo/Introduction.rst diff --git a/docs/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst b/doc/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst similarity index 100% rename from docs/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst rename to doc/UsersGuide/source/BackgroundInfo/TechnicalOverview.rst diff --git a/docs/UsersGuide/source/BackgroundInfo/index.rst b/doc/UsersGuide/source/BackgroundInfo/index.rst similarity index 100% rename from docs/UsersGuide/source/BackgroundInfo/index.rst rename to doc/UsersGuide/source/BackgroundInfo/index.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/AQM.rst b/doc/UsersGuide/source/BuildingRunningTesting/AQM.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/AQM.rst rename to doc/UsersGuide/source/BuildingRunningTesting/AQM.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/BuildSRW.rst b/doc/UsersGuide/source/BuildingRunningTesting/BuildSRW.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/BuildSRW.rst rename to doc/UsersGuide/source/BuildingRunningTesting/BuildSRW.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst b/doc/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst rename to doc/UsersGuide/source/BuildingRunningTesting/ContainerQuickstart.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/DefaultVarsTable.rst b/doc/UsersGuide/source/BuildingRunningTesting/DefaultVarsTable.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/DefaultVarsTable.rst rename to doc/UsersGuide/source/BuildingRunningTesting/DefaultVarsTable.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/Quickstart.rst b/doc/UsersGuide/source/BuildingRunningTesting/Quickstart.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/Quickstart.rst rename to doc/UsersGuide/source/BuildingRunningTesting/Quickstart.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst b/doc/UsersGuide/source/BuildingRunningTesting/RunSRW.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/RunSRW.rst rename to doc/UsersGuide/source/BuildingRunningTesting/RunSRW.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/Tutorial.rst b/doc/UsersGuide/source/BuildingRunningTesting/Tutorial.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/Tutorial.rst rename to doc/UsersGuide/source/BuildingRunningTesting/Tutorial.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/VXCases.rst b/doc/UsersGuide/source/BuildingRunningTesting/VXCases.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/VXCases.rst rename to doc/UsersGuide/source/BuildingRunningTesting/VXCases.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/WE2Etests.rst b/doc/UsersGuide/source/BuildingRunningTesting/WE2Etests.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/WE2Etests.rst rename to doc/UsersGuide/source/BuildingRunningTesting/WE2Etests.rst diff --git a/docs/UsersGuide/source/BuildingRunningTesting/index.rst b/doc/UsersGuide/source/BuildingRunningTesting/index.rst similarity index 100% rename from docs/UsersGuide/source/BuildingRunningTesting/index.rst rename to doc/UsersGuide/source/BuildingRunningTesting/index.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/ConfigWorkflow.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/ConfigWorkflow.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/ConfigWorkflow.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/ConfigWorkflow.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/DefineWorkflow.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/DefineWorkflow.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/DefineWorkflow.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/DefineWorkflow.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/InputOutputFiles.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/InputOutputFiles.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/InputOutputFiles.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/InputOutputFiles.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/LAMGrids.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/LAMGrids.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/LAMGrids.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/LAMGrids.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/TemplateVars.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/TemplateVars.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/TemplateVars.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/TemplateVars.rst diff --git a/docs/UsersGuide/source/CustomizingTheWorkflow/index.rst b/doc/UsersGuide/source/CustomizingTheWorkflow/index.rst similarity index 100% rename from docs/UsersGuide/source/CustomizingTheWorkflow/index.rst rename to doc/UsersGuide/source/CustomizingTheWorkflow/index.rst diff --git a/docs/UsersGuide/source/Reference/FAQ.rst b/doc/UsersGuide/source/Reference/FAQ.rst similarity index 100% rename from docs/UsersGuide/source/Reference/FAQ.rst rename to doc/UsersGuide/source/Reference/FAQ.rst diff --git a/docs/UsersGuide/source/Reference/Glossary.rst b/doc/UsersGuide/source/Reference/Glossary.rst similarity index 100% rename from docs/UsersGuide/source/Reference/Glossary.rst rename to doc/UsersGuide/source/Reference/Glossary.rst diff --git a/docs/UsersGuide/source/Reference/RocotoInfo.rst b/doc/UsersGuide/source/Reference/RocotoInfo.rst similarity index 100% rename from docs/UsersGuide/source/Reference/RocotoInfo.rst rename to doc/UsersGuide/source/Reference/RocotoInfo.rst diff --git a/docs/UsersGuide/source/Reference/index.rst b/doc/UsersGuide/source/Reference/index.rst similarity index 100% rename from docs/UsersGuide/source/Reference/index.rst rename to doc/UsersGuide/source/Reference/index.rst diff --git a/docs/UsersGuide/source/SSHIntro.rst b/doc/UsersGuide/source/SSHIntro.rst similarity index 100% rename from docs/UsersGuide/source/SSHIntro.rst rename to doc/UsersGuide/source/SSHIntro.rst diff --git a/docs/UsersGuide/source/_static/custom.css b/doc/UsersGuide/source/_static/custom.css similarity index 100% rename from docs/UsersGuide/source/_static/custom.css rename to doc/UsersGuide/source/_static/custom.css diff --git a/docs/UsersGuide/source/_static/theme_overrides.css b/doc/UsersGuide/source/_static/theme_overrides.css similarity index 79% rename from docs/UsersGuide/source/_static/theme_overrides.css rename to doc/UsersGuide/source/_static/theme_overrides.css index deb45e1974..a9672944ba 100644 --- a/docs/UsersGuide/source/_static/theme_overrides.css +++ b/doc/UsersGuide/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 b/doc/UsersGuide/source/_templates/.gitignore similarity index 100% rename from docs/UsersGuide/source/_templates/.gitignore rename to doc/UsersGuide/source/_templates/.gitignore diff --git a/docs/UsersGuide/source/conf.py b/doc/UsersGuide/source/conf.py similarity index 98% rename from docs/UsersGuide/source/conf.py rename to doc/UsersGuide/source/conf.py index c2c86e408f..cc348f18da 100644 --- a/docs/UsersGuide/source/conf.py +++ b/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 b/doc/UsersGuide/source/index.rst similarity index 100% rename from docs/UsersGuide/source/index.rst rename to doc/UsersGuide/source/index.rst diff --git a/docs/UsersGuide/source/references.bib b/doc/UsersGuide/source/references.bib similarity index 100% rename from docs/UsersGuide/source/references.bib rename to doc/UsersGuide/source/references.bib diff --git a/docs/UsersGuide/source/tables/SRW_NATLEV_table.csv b/doc/UsersGuide/source/tables/SRW_NATLEV_table.csv similarity index 100% rename from docs/UsersGuide/source/tables/SRW_NATLEV_table.csv rename to doc/UsersGuide/source/tables/SRW_NATLEV_table.csv diff --git a/docs/UsersGuide/source/tables/SRW_NATLEV_table.rst b/doc/UsersGuide/source/tables/SRW_NATLEV_table.rst similarity index 100% rename from docs/UsersGuide/source/tables/SRW_NATLEV_table.rst rename to doc/UsersGuide/source/tables/SRW_NATLEV_table.rst diff --git a/docs/UsersGuide/source/tables/SRW_PRSLEV_table.csv b/doc/UsersGuide/source/tables/SRW_PRSLEV_table.csv similarity index 100% rename from docs/UsersGuide/source/tables/SRW_PRSLEV_table.csv rename to doc/UsersGuide/source/tables/SRW_PRSLEV_table.csv diff --git a/docs/UsersGuide/source/tables/SRW_PRSLEV_table.rst b/doc/UsersGuide/source/tables/SRW_PRSLEV_table.rst similarity index 100% rename from docs/UsersGuide/source/tables/SRW_PRSLEV_table.rst rename to doc/UsersGuide/source/tables/SRW_PRSLEV_table.rst diff --git a/docs/UsersGuide/source/tables/Tests.csv b/doc/UsersGuide/source/tables/Tests.csv similarity index 100% rename from docs/UsersGuide/source/tables/Tests.csv rename to doc/UsersGuide/source/tables/Tests.csv diff --git a/docs/UsersGuide/source/tables/Tests.rst b/doc/UsersGuide/source/tables/Tests.rst similarity index 100% rename from docs/UsersGuide/source/tables/Tests.rst rename to doc/UsersGuide/source/tables/Tests.rst diff --git a/docs/UsersGuide/source/tables/fix_file_list.rst b/doc/UsersGuide/source/tables/fix_file_list.rst similarity index 100% rename from docs/UsersGuide/source/tables/fix_file_list.rst rename to doc/UsersGuide/source/tables/fix_file_list.rst diff --git a/docs/UsersGuide/source/tables/.DS_Store b/docs/UsersGuide/source/tables/.DS_Store deleted file mode 100644 index c478f9e8ab..0000000000 Binary files a/docs/UsersGuide/source/tables/.DS_Store and /dev/null differ