Moving documentation to ReadTheDocs #438
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…remove title page.
…CCPP tech doc), fix deprecated feature in conf.py
…atest changes or building with spack-stack; that will come in a subsequent PR
|
@mkavulich this looks really great! I checked out the branch to add documentation for the single precision build and it was easy to use and worked well. A few comments:
Anyway, these are just small things, overall it worked very well for me! |
|
@scrasmussen Thanks for the review! I have updated the Makefile, though I am unable to test the latex/pdf rule because I can not install latexmk on my machine (which is part of why this whole conversation of moving to ReadTheDocs started!). I also added a README.md file to assist people who are interested in building the HTML or PDF documentation. With regards to renaming documents/chapters, I kept the names from the original |
scrasmussen
approved these changes
Mar 27, 2024
hertneky
requested changes
Mar 27, 2024
hertneky
approved these changes
Apr 3, 2024
dustinswales
approved these changes
Apr 3, 2024
grantfirl
approved these changes
Apr 3, 2024
|
I didn't review in detail, although, in general, it looks great. Although I love LaTeX, this is a better way to format software docs in pretty much every way. Thanks for doing this. |
mzhangw
added a commit
to mzhangw/ccpp-scm
that referenced
this pull request
May 22, 2024
* upstream/main: Add GP SDFs/NMLs to SCM minor fix/cleanup Add namelist option and sigmab (tracer) for HR3 add SCM_RRFS_v1 SDF, nml, tracer file; update suite_info; update scm_type_defs to recgonize new tracers add script to download and stage climatological aerosol data and fix typo in HR3 namelist merge in changes from NCAR#428 from @hertneky add CITATION.cff file from @scrasmussen from NCAR#458 merge changes from @hertneky in NCAR#446 add HR3 suite and physics namelist from NCAR#445 from @bluefinweiwei changes from @bluefinweiwei for PR#419 Revert submodules Update physics Address reviewers comments update ccpp/physics submodule pointer Moving documentation to ReadTheDocs (NCAR#438) Synced physics update ccpp/physics submodule update ccpp/framework update CCPP_typedefs to work with PR#181 update ccpp/physics and .gitmodules Added step to skip gridpoint in ensemble if error during case generation Added utility script to create input file containing replay points Omission from previous commit Add capability to use input file with longitude and latitude lists update ccpp/physics submodule update .gitmodules for whitespace change removal update ccpp/physics and .gitmodules update ccpp/physics and .gitmodules update ccpp/physics submodule pointer point .gitmodules back to my branch for CI testing update ccpp/physics and .gitmodules update ccpp/physics and .gitmodules update ccpp/physics and .gitmodules Cleanup/Housekeeping. Remove unnecessary interpolation step Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Revert change to CMakeLists Revert change to CMakeLists Revert change to CMakeLists Revert change to CMakeLists Update CI Update CI Add file for Nvidia RTS Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update cmakelists Updated CI Update CI Update CI Update CI Update CI Update CMakeLists for Nvidia support Update CMakeLists for Nvidia support Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Update CI Foundatio for Nvidia CI script Synced physics Small cahnge from physics needed for replay Replay with RUC and NoahMP LSM working Some changes for Man to test If using model initial conditions and forcing from the UFS (e.g. Replay mode) with an active LSM, the SCM performs a cold-start initialization for the LSM. That is, UFS replay mode currently support cases generated from UFS Restart files (e.g spun up (warm) LSM parameters) update ccpp/physics and revert .gitmodules update ccpp/physics submodule and revert .gitmodules changes to work with ufs/dev PR#155 update for ufs/dev PR#94 update ccpp/physics and .gitmodules update ccpp/physics and .gitmodules after testing
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR removes the old, LaTeX-based users guide in favor of RST files that are buildable with Sphinx. These new docs have been configured to automatically build with each commit to
mainon ReadTheDocs, and can be viewed here: html | PDFFor limitations in the new docs compared to the previous LaTeX/PDF, see this comment
NOTE: The original LaTeX files were auto-converted from
.texto.rstusing thepandocutility, and then manually updated for format. The conversion was not perfect: in particular, most section/chapter links were broken, and allcode-case textwas omitted from the converted docs. These problems needed to be fixed manually, but it's entirely possible some of these may have slipped into the final product.Resolves #418