Skip to content

CLMU Technote: Make .rst file of .docx file and get in the docs - #4179

Draft
slevis-lmwg wants to merge 8 commits into
ESCOMP:b4b-devfrom
slevis-lmwg:clmu_technote
Draft

CLMU Technote: Make .rst file of .docx file and get in the docs#4179
slevis-lmwg wants to merge 8 commits into
ESCOMP:b4b-devfrom
slevis-lmwg:clmu_technote

Conversation

@slevis-lmwg

Copy link
Copy Markdown
Contributor

Description of changes

See title.

Specific notes

Contributors other than yourself, if any:
@olyson

CTSM issues resolved or otherwise addressed, if any:
Resolves #4175

Requirements before merge:

@slevis-lmwg slevis-lmwg self-assigned this Aug 19, 2026
@slevis-lmwg slevis-lmwg added documentation additions or edits to user-facing documentation or its infrastructure b4b bit-for-bit docs:new New documentation needed (e.g., for a new feature) docs-loc:tech-note Relates to Technical Note (science) labels Aug 19, 2026
@slevis-lmwg slevis-lmwg moved this to In Progress in CLM documentation Aug 19, 2026
@slevis-lmwg slevis-lmwg moved this from Todo to In Progress in LMWG: Sprint Planning Board Aug 19, 2026
@slevis-lmwg

slevis-lmwg commented Aug 19, 2026

Copy link
Copy Markdown
Contributor Author
  • Try the python script on the .docx file with the MathType equations /glade/u/home/oleson/CLMU_Tech_Note/CLMU_Tech_Note.docx in case it does better
    UPDATE: It's worse, but I also see some valid missing-word corrections that I will bring in. BUT the latter raises concerns of difficult-to-spot missing words among larger diffs in the rest of the doc.
  • Compare the .md and .rst files to see which one we prefer
  • Tried converting to .md from the MathType version, and the equations became images, which is not what we want

Then we're back to this list...

  • The Workflow test currently fails due to fake degree signs and curly apostrophes and quotes
  • Then keep going through the doc to find all the formatting issues
  • We also need to
    • move the refs to the References section and make links
    • make links of all the Figures and Tables
    • make links of all the Equations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit docs:new New documentation needed (e.g., for a new feature) docs-loc:tech-note Relates to Technical Note (science) documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: In Progress
Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant