Docs docs: Add instructions for embedding files in docs#3982
Merged
samsrabin merged 3 commits intoESCOMP:b4b-devfrom May 7, 2026
Merged
Docs docs: Add instructions for embedding files in docs#3982samsrabin merged 3 commits intoESCOMP:b4b-devfrom
samsrabin merged 3 commits intoESCOMP:b4b-devfrom
Conversation
samsrabin
added
documentation
samsrabin
added
PR status: awaiting review
samsrabin
removed
the
next
wwieder
approved these changes
May 5, 2026
Contributor
wwieder
left a comment
wwieder
left a comment
There was a problem hiding this comment.
These are helpful examples and it seems to render fine too.
Minor editorial suggestions you can decide on, Sam, but I don't feel like I need to review this again.
samsrabin
commented
May 7, 2026
Co-authored-by: will wieder <wwieder@ucar.edu> Co-authored-by: Sam Rabin <samrabin@ucar.edu>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Adds instructions for embedding reStructuredText files within other reStructuredText files, and Markdown files within other Markdown files.
Specific notes
Contributors other than yourself, if any: None
CTSM Issues Fixed:
Are answers expected to change (and if so in what way)? No
Any User Interface Changes (namelist or namelist defaults changes)? No
Does this create a need to change or add documentation? Did you do so? n/a
Testing performed, if any: Doc build tests and previews.