Skip to content

Convert rules document to an automated ReadTheDocs build, add comments to metadata files - #159

Draft
mkavulich wants to merge 21 commits into
mainfrom
feature/readthedocs
Draft

mkavulich wants to merge 21 commits into
mainfrom
feature/readthedocs

Conversation

@mkavulich

Copy link
Copy Markdown
Collaborator

Description

The current plain .rst document (StandardNameRules.rst) gives us some formatting capabilities over a plain .txt file, but has major limitations. A big one is the lack of embedded images, and limited linking capabilities. Sphinx-generated html documents give us these capabilities, as well as an easily-referenceable and versioned HTML build of the standard name rules, hosted on ReadTheDocs.

This PR moves the rules as-is to the docs/chapters directory, with the only changes being formatting and splitting the rules into multiple files for different chapters. The build for this branch can be found at https://esm-standard-names.readthedocs.io/en/feature-readthedocs/index.html

I also took the opportunity to fix the Metadata files to include comments.

Issues

Resolves #158

mkavulich and others added 21 commits September 21, 2026 15:56
…_skin_temperature" definition, and return proper skin temperature naming accordingly
…ned "friction-temperature", including definition and citation.
…r "at_surface_interface" due to existing conflicting definition of "bottom-of-atmosphere" in radiation community. Will stick with the slightly more ambiguous but overall less confusing "at_surface" as a synonym for "at_surface_interface", with appropriate definitions.
… site

Splits the single StandardNamesRules.rst file verbatim into per-chapter
files under docs/chapters/, adds Sphinx scaffolding (conf.py, index.rst,
requirements.txt) and a top-level .readthedocs.yaml so the rules can be
built and published on Read the Docs. StandardNamesRules.rst is replaced
with a stub pointing to the new docs/ location, and README.md is updated
to match.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- naming_rules.rst: repair a malformed grid table (missing column
  divider in the top border, a stray space instead of a dash in a row
  separator) that was merging/misrendering the control-oriented
  variables table; also add the missing colon on the ".. _Rules"
  target.
- qualifiers.rst: escape trailing underscores in "surface_", "since_",
  "over_", and "reset_every_" so they render as plain text instead of
  being parsed as broken hyperlink references.
- technical_specifications.rst: use "::" instead of ":" to introduce
  the exner_function XML snippet so it renders as a code block instead
  of a garbled block quote/definition list.
- index.rst: lengthen the title over/underline to match the title
  text length.

No wording changes; docs/ now builds with zero Sphinx warnings.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Replace the three plain hyperlinks to wiki-hosted PNGs in
naming_rules.rst with .. figure:: directives, so the images render
inline on the page instead of requiring a click-through. Each figure
gets descriptive alt text and a caption; the images continue to be
served from raw.githubusercontent.com rather than being vendored into
the repo.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@climbfuji climbfuji left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer converting it to a markdown document that can be viewed directly in any modern IDE (VSCode, Xcode, ...) and on GitHub.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Comments do not appear alongside the standard name definitions in either Metadata file

2 participants