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

Mll section summaries #16

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Mll section summaries #16

merged 3 commits into from
Jan 14, 2025

Conversation

smguzik
Copy link
Contributor

@smguzik smguzik commented Jan 13, 2025

Creates summaries of MLL sections using a custom directive. Tested on sphinx 5.3.0. As requested, nearly all summaries are automatically produced from doxygen. There are two exceptions:

  • The doxygen for Configuring CGNS Internals was split in two so I just did this one manually.
  • There is no summary for the Error Handling section primarily because one of the descriptions is not brief. The archived MLL didn't have a summary for this section either.

Additional fixes:

  • Added missing flow solution data functions to MLL documentation.
  • Made references consistent with doxygen xml sources where different (in most cases these were consistent).
  • Slightly restructured parallel api rst doc primarily to better position references.

Closes #13

@smguzik smguzik requested review from MicK7 and brtnfld January 13, 2025 21:14
@smguzik smguzik linked an issue Jan 13, 2025 that may be closed by this pull request
Copy link
Member

@brtnfld brtnfld left a comment

Choose a reason for hiding this comment

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

Nice implementation. Looks great!

@brtnfld
Copy link
Member

brtnfld commented Jan 13, 2025

  • There is no summary for the Error Handling section primarily because one of the descriptions is not brief. The archived MLL didn't have a summary for this section either.

I think we should address this at some point, along with the lengthy brief.

@brtnfld
Copy link
Member

brtnfld commented Jan 14, 2025

I updated the error docs. I'll have a PR when GitHub is working again.

@smguzik
Copy link
Contributor Author

smguzik commented Jan 14, 2025

Okay, I enabled the summary for the Error Handling section. Once the change is merged in the source, it should look good.

@smguzik smguzik merged commit be36458 into develop Jan 14, 2025
2 checks passed
@smguzik smguzik deleted the mll-section-summaries branch January 14, 2025 02:25
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.

Brief lists of MLL functions in each section
2 participants