Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some formatting in Registry for generating docs #81

Closed

Conversation

xylar
Copy link
Collaborator

@xylar xylar commented Feb 29, 2024

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

To generate Latex documentation from the Registry, we need to
escape Latex in the namelist and variable descriptions.
@xylar
Copy link
Collaborator Author

xylar commented Feb 29, 2024

Here is the resulting user's guide:

mpas_ocean_users_guide.pdf

@xylar
Copy link
Collaborator Author

xylar commented Feb 29, 2024

Here is the PR where I'm proposing to update the User's Guide using these changes:
MPAS-Dev/MPAS-Documents#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
Copy link
Collaborator Author

xylar commented Mar 12, 2024

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

@xylar xylar closed this Mar 12, 2024
@xylar xylar reopened this Mar 12, 2024
Copy link

@mark-petersen mark-petersen left a comment

Choose a reason for hiding this comment

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

Yes, looks good. Thanks!

@xylar
Copy link
Collaborator Author

xylar commented Mar 13, 2024

Thanks @mark-petersen!

Replaced by E3SM-Project#6293

@xylar xylar closed this Mar 13, 2024
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.

2 participants