Commit Graph

10651 Commits

Author SHA1 Message Date
Ray Speth
04cc5b459a Add version switcher to Sphinx docs 2023-08-08 21:58:33 -04:00
Ray Speth
4c89ce5f27 Restore NumFOCUS/donation links 2023-08-08 21:58:33 -04:00
Ray Speth
7e5658f6e3 Make Sphinx header links consistent with cantera.org header 2023-08-08 21:58:33 -04:00
Ray Speth
f3fe29781e Switch to PyData Sphinx theme 2023-08-08 21:58:33 -04:00
Ingmar Schoegl
277bce003a Add NASA 9-coefficient reference 2023-08-08 17:34:10 -04:00
Ingmar Schoegl
56cea1748d Update falloff citations
Ensure that docstrings are consistent with science section
2023-08-08 17:34:10 -04:00
Ingmar Schoegl
fd40e884b6 Add tpx citations 2023-08-08 17:34:10 -04:00
Ray Speth
1f580a3978 [Doc] Fix some spelling errors 2023-08-07 17:56:56 -05:00
Ray Speth
ac6f49c5e8 Delete duplicated documentation 2023-08-07 17:56:56 -05:00
Ray Speth
f902ad82f8 [Doc] Update citations for some transport classes 2023-08-07 17:56:56 -05:00
Ray Speth
c82781e3ed [Doc] Remove obsolete reference to CA_Mode 2023-08-07 17:56:56 -05:00
Ray Speth
a47153aece [Doc] Reduce clutter in C++ member function docs 2023-08-07 17:56:56 -05:00
Ray Speth
075d33b337 [Doc] Fix notation for natural log
Always write \log_{10} in the rare instances where that's what's
actually meant.
2023-08-07 17:56:56 -05:00
Ray Speth
cdaac33dea [Doc] Fix obsolete references to SimpleThermo 2023-08-07 17:56:56 -05:00
Ray Speth
d95d28fb08 [Doc] Remove admonition about testing from MixtureFugacityTP
The classes derived from this (RedlichKwongMFTP and PengRobinson)
have adequate tests.
2023-08-07 17:56:56 -05:00
Ray Speth
373b3e0fb9 [Doc] Revise ThermoPhase documentation
Extract content from "thermoprops.dox" to populate the docstring for
the ThermoPhase class and the "thermoprops" group.

Fix numerous areas where this documentation was outdated or incorrect.
2023-08-07 17:56:56 -05:00
Ray Speth
7f5112239a [Doc] Remove broken link to non-existent Electrochemical reaction type 2023-08-07 17:56:56 -05:00
Ray Speth
7bb1f09921 [Doc] Use Doxylink to link to C++ classes
No need to link directly to the "details" section since that now
appears close to the top of the page.
2023-08-07 17:56:56 -05:00
Ray Speth
1c0f5e458f [Doc] Note version added for recent ThermoPhase models 2023-08-07 17:56:56 -05:00
Ray Speth
63f9bb04b3 [Doc] Fix alphabetization of phase models 2023-08-07 17:56:56 -05:00
Ray Speth
0b60e87918 Remove obsolete Doxygen options
These options generate warnings with Doxygen 1.9.6
2023-08-07 17:56:56 -05:00
Ray Speth
0a0087fc39 [CI] Build docs with Sphinx 5.1.1
Sphinx 3.x isn't compatible with our Nikola plugins, and the old
extension compatibility issues with 4.x no longer hold.

Sphinx 5.1.1 seems to be the most recent version that doesn't have
formatting issues for us.

Resolves Cantera/enhancements#175
2023-08-07 17:56:56 -05:00
Ingmar Schoegl
a900edfc48 Use C++17 attribute for deprecated types 2023-08-06 11:22:39 -05:00
Ingmar Schoegl
8ab42145a4 [CI] Skip pint on some runners 2023-08-06 11:18:02 -05:00
Ingmar Schoegl
a22fe7dc32 [unittest] Handle case where pint is not installed 2023-08-06 11:18:02 -05:00
Ingmar Schoegl
38b76a0476 Replace \log by \ln 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
d951bd5ee6 [docs] Fix new Doxygen warnings 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
ad251db8b5 [docs] Fix ConstCpPoly docstring
Use same syntax as on Cantera science section
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
bf98c1826a [docs] Fix LaTeX log/ln/exp 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
5b6cf5fb84 Remove % in group definition string 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
855f239bb9 [docs] Add Doxygen eqnarray 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
070c226fba [docs] Replace remaining Doxygen commands 2023-08-06 09:31:37 -05:00
Ingmar Schoegl
d92d977ca9 [docs] Sort BibTeX entries alphabetically 2023-08-06 09:31:37 -05:00
Ray Speth
e2993793e2 [CI] Check for whitespace errors 2023-08-06 10:22:41 -04:00
Ray Speth
a23f2da352 [CI] Always run all linter steps 2023-08-06 10:22:41 -04:00
Ray Speth
2a0e4e95f3 [CI] Move lint checks to a separate workflow 2023-08-06 10:22:41 -04:00
Ray Speth
c86220ecfe [CI] Add linter check for misleading Doxygen blocks 2023-08-06 10:22:41 -04:00
Ray Speth
3332319f85 [CI] Relax timeouts on for Intel compiler setup 2023-08-05 16:26:32 -04:00
Ray Speth
53396d4414 Clean up line wrapping and indentation 2023-08-05 16:26:32 -04:00
Ray Speth
c50b8b4faf Fix Matlab toolbox compilation
This code isn't part of namespace Cantera, so can't use the
typedefs that are specified in that namespace.
2023-08-05 16:26:32 -04:00
Ingmar Schoegl
25f6834da9 Improve formatting 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
64ade35c22 Using std::string 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
0df90be93e Using std::map 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
ddd803c630 Using std::function 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
8f320c217c Using std::pair 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
3dae4d458b Using std::unique_ptr 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
e482e13ca2 Using std::shared_ptr 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
1b81689d40 Using std::vector 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
c09611b165 Using std::make_shared 2023-08-05 16:26:32 -04:00
Ingmar Schoegl
86b2a139c7 Replace doublereal 2023-08-05 16:26:32 -04:00