dtcenter/METdataio

Documentation: Make Headers Consistent in All METdataio Guides

Closed this issue · 0 comments

This is a sub-issue of METplus#898.
dtcenter/METplus#898

This task is for all METplus component. This specific issue is for METdataio only:

The headers for the METdataio components User's Guides may not be consistent, but we want them to be.

Here is the syntax from the RST docs (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections):

# with overline, for parts (e.g. the RTD documentation for the component (i.e. docs/index.rst), each guide (e.g. User's Guide, Contributor's Guide) (i.e. docs/Users_Guide/index.rst, docs/Contributors_Guide/index.rst))
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Time Estimate

Estimate the amount of work required here.
Issues should represent approximately 1 to 3 days of work.

Funding Source

2783543 - Lisa has hours on this account.

Define the Metadata

Assignee

  • Select engineer(s) Lisa Goodrich
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions