Improve docs, mostly behind the scenes #2211
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
samsrabin
added
the
documentation
samsrabin
added
the
PR status: ready
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.
Description of changes
Makes some changes to get RestructuredText to render correctly in VSCode. Also improves .rst file searchability by straightening curly quotes/apostrophes as well as by removing manual line breaks throughout the Tech Note and User's Guide. Finally, includes some small fixes and cleanup.
Specific notes
Contributors other than yourself, if any: None
CTSM Issues Fixed: Resolves #2135.
Are answers expected to change (and if so in what way)? No.
Any User Interface Changes (namelist or namelist defaults changes)? No.
Testing performed, if any: Rendered HTML looks good.