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

More Sphinx / Doxygen updates #1590

Merged
merged 8 commits into from Aug 16, 2023
Merged

More Sphinx / Doxygen updates #1590

merged 8 commits into from Aug 16, 2023

Conversation

speth
Copy link
Member

@speth speth commented Aug 16, 2023

Changes proposed in this pull request

  • Use 'warning' admonition in Sphinx docs so these will be formatted similar to 'deprecated' admonitions now that we're using the PyData Sphinx theme.
  • Add BibTeX entries for more references
  • Remove references to obsolete member of VPStandardStateTP
  • Fix Contributor Covenant link in README.rst
  • Expand trees in Doxygen by default -- saves having to expand the "Cantera" namespace every time you go to the class / namespace list
  • Adjust ordering of Doxygen pages to move auxiliary pages towards the bottom, and emphasize "class" documentation over the "namespace" documentation
  • Make transport properties a top-level group in Doxygen, and move Phase and ThermoPhase into base thermoprops group

If applicable, provide an example illustrating new features this pull request is introducing

Member function with warning and versionadded directives:


image

Default view of the "Classes" page:


image


Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

This results in formatting similar to other admonitions like 'deprecated'
when using the PyData Sphinx theme.
@codecov
Copy link

codecov bot commented Aug 16, 2023

Codecov Report

Merging #1590 (8e364b8) into main (43fca53) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           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           
Files Changed Coverage Δ
include/cantera/oneD/IonFlow.h 73.33% <ø> (ø)
include/cantera/thermo/HMWSoln.h 40.00% <ø> (ø)
include/cantera/thermo/MixtureFugacityTP.h 33.33% <ø> (ø)
include/cantera/thermo/MolalityVPSSTP.h 80.00% <ø> (ø)
include/cantera/thermo/PDSS_HKFT.h 100.00% <ø> (ø)
include/cantera/thermo/Phase.h 78.57% <ø> (ø)
include/cantera/thermo/ThermoPhase.h 47.16% <ø> (ø)
include/cantera/thermo/VPStandardStateTP.h 100.00% <ø> (ø)
include/cantera/transport/Transport.h 17.43% <ø> (ø)
interfaces/cython/cantera/kinetics.pyx 91.81% <ø> (+0.43%) ⬆️
... and 3 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@ischoegl ischoegl left a 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.

doc/doxygen/cantera.bib Outdated Show resolved Hide resolved
doc/doxygen/cantera.bib Outdated Show resolved Hide resolved
doc/doxygen/cantera.bib Show resolved Hide resolved
doc/doxygen/cantera.bib Outdated Show resolved Hide resolved
@speth
Copy link
Member Author

speth commented Aug 16, 2023

Thanks for catching those inconsistencies, @ischoegl. This should be good to go now.

@ischoegl ischoegl merged commit cde1e79 into Cantera:main Aug 16, 2023
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants