search

E3SM-Ocean-Discussion / E3SM

Ocean discussion repository, for ocean issues and longer-term pull requests for E3SM source code. Please make pull requests that are ready to merge into https://github.com/E3SM-Project/E3SM
https://e3sm.org
Other
1 stars 0 forks source link

Fix some formatting in Registry for generating docs #81

Closed xylar closed 8 months ago

xylar commented 9 months ago

To generate Latex documentation from the Registry, we need to escape Latex in the namelist and variable descriptions.

xylar commented 9 months ago

Here is the resulting user's guide:

mpas_ocean_users_guide.pdf

xylar commented 9 months ago

Here is the PR where I'm proposing to update the User's Guide using these changes: https://github.com/MPAS-Dev/MPAS-Documents/pull/77 As I mention there, the auto-generated documentation is constructed using the tool I updated here: https://github.com/xylar/MPAS-Tools/blob/update-parse-registry/python_scripts/namelist_generation/parse_xml_registry.py

xylar commented 8 months ago

@mark-petersen, could you let me know if these changes look okay? If so, I'll move over to E3SM.

xylar commented 8 months ago

Thanks @mark-petersen!

Replaced by https://github.com/E3SM-Project/E3SM/pull/6293