dtcenter / METdataio

https://metdataio.readthedocs.io/en/latest/index.html
Apache License 2.0
5 stars 3 forks source link

Documentation: Make Headers Consistent in All METdataio Guides #238

Closed lisagoodrich closed 11 months ago

lisagoodrich commented 11 months ago

This is a sub-issue of METplus#898. https://github.com/dtcenter/METplus/issues/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

Labels

Projects and Milestone