-
-
Notifications
You must be signed in to change notification settings - Fork 346
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
More Sphinx / Doxygen updates #1590
Conversation
This results in formatting similar to other admonitions like 'deprecated' when using the PyData Sphinx theme.
Codecov Report
@@ Coverage Diff @@
## main #1590 +/- ##
=======================================
Coverage 70.60% 70.61%
=======================================
Files 379 379
Lines 59153 59153
Branches 21252 21252
=======================================
+ Hits 41766 41768 +2
+ Misses 14313 14311 -2
Partials 3074 3074
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @speth! A couple of BibTeX quibbles (doxygen uses full first/middle names if they are provided, resulting in inconsistent entries)
Regarding doxygen, there's also the @tparam
issue (see here) that we may want to address eventually (not necessarily now). It's probably best an enhancement request, but I keep forgetting about it.
Move auxiliary pages towards the bottom, and emphasize class documentation over the "namespace" documentation
Thanks for catching those inconsistencies, @ischoegl. This should be good to go now. |
Changes proposed in this pull request
VPStandardStateTP
README.rst
thermoprops
groupIf applicable, provide an example illustrating new features this pull request is introducing
Member function with
warning
andversionadded
directives:Default view of the "Classes" page:
Checklist
scons build
&scons test
) and unit tests address code coverage