Commit Graph

11154 Commits

Author SHA1 Message Date
Ray Speth
03ee315afa [Doc] Add revised ck2yaml tutorial
Mostly drawn from the corresponding page in cantera-website, with
some updates and removing content covered in the reference guide.
2023-10-22 08:08:57 -05:00
ssun30
3a9bc6a66d Density/specific volume are now basis dependent 2023-10-18 16:42:11 -04:00
ssun30
c452b8a4d9 Updated documentation for stoich coeff methods 2023-10-18 16:42:11 -04:00
ssun30
903d48bbbf Fixed setter errors with unit conversions 2023-10-18 16:42:11 -04:00
ssun30
bb7c01a836 Added error handling for out of bounds indices 2023-10-18 16:42:11 -04:00
ssun30
cc54703c5b Removed unnecessary variable root_dir 2023-10-18 16:42:11 -04:00
ssun30
6ce0ef5b73 Fixed issues in ThermoPhase to pass more tests 2023-10-18 16:42:11 -04:00
ssun30
7c8e3e4492 Fixed Kinetics class so all tests pass 2023-10-18 16:42:11 -04:00
ssun30
840def2897 Changed how ThermoPhase is printed. 2023-10-18 16:42:11 -04:00
ssun30
40a9373176 Added Cantera error identifiers. 2023-10-18 16:42:11 -04:00
ssun30
aec7e17664 Added ctRoot to gitignore 2023-10-18 16:42:11 -04:00
Ray Speth
de77fa3c14 [Doc] Use cards for Examples landing page 2023-10-09 16:40:37 -04:00
Ray Speth
134fce72e4 [Doc] Avoid needing two lines for header links 2023-10-09 16:40:37 -04:00
Ray Speth
eaed836915 [Doc] Simplify addition of "Community" link 2023-10-09 16:40:37 -04:00
Ray Speth
10f6158a07 Enable sphinx-copybutton extension 2023-10-09 16:40:37 -04:00
Ray Speth
a7021138a1 Migrate compilation docs into Sphinx/MyST 2023-10-09 16:40:37 -04:00
Ray Speth
3cebba3773 [Doc] Add more stub pages to the Sphinx docs 2023-10-09 16:40:37 -04:00
Ray Speth
4c4e9db03b Use higher-res icon in Doxygen title area 2023-10-09 16:40:37 -04:00
Ray Speth
d496314cc7 Set favicon for Sphinx and Doxygen docs 2023-10-09 16:40:37 -04:00
Ray Speth
3416eba3b8 [Doc] Add admonitions redirecting users to stable docs 2023-10-09 16:40:37 -04:00
Ray Speth
b30db6a8b6 [Doc] Reorganize Sphinx index pages and convert to MyST 2023-10-09 16:40:37 -04:00
Ray Speth
582f04a755 [Doc] Update to pydata-sphinx-theme 0.14 and fix some styling issues 2023-10-09 16:40:37 -04:00
Ray Speth
c96e470e61 Add Python tutorial as a MyST notebook
Adds dependency on myst-nb, which is currently pinned to Sphinx<6
2023-10-09 16:40:37 -04:00
Ray Speth
2767d00e53 [Doc] Add bibliography to Sphinx docs 2023-10-09 16:40:37 -04:00
Ray Speth
b463f001bb [Doc] Fix syntax error in cantera.bib 2023-10-09 16:40:37 -04:00
Ray Speth
8084eae338 [Doc] Create skeleton for revised layout 2023-10-09 16:40:37 -04:00
Ray Speth
221ae6a5c2 [Doc] Use 'python' instead of 'cython' for filenames and refs
Partially addresses Cantera/cantera-website#229
2023-10-09 16:40:37 -04:00
Ray Speth
c533ca90bb [Doc] Flatten output directory structure
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
2023-10-09 16:40:37 -04:00
Ray Speth
70b08041e2 [Doc] Create structure for "science" docs
Use LatticePhase as an initial trial for moving scientific model docs
into Sphinx using MyST.
2023-10-09 16:40:37 -04:00
Ray Speth
d896104e10 Remove previous/next page links from Sphinx docs 2023-10-09 16:40:37 -04:00
Ray Speth
38a0b13dfb Reformat "Reference" landing page
Put C++ API documentation on an equal footing
2023-10-09 16:40:37 -04:00
Ray Speth
5821dceef5 Enable MyST usage in Sphinx 2023-10-09 16:40:37 -04:00
Ray Speth
d62dc233c9 Modify Doxygen navbar to link to Sphinx docs 2023-10-09 16:40:37 -04:00
Ray Speth
7eed1bdcc0 [SCons] Use gcc options by default for unknown compilers
This allows using the generic 'cc' and 'c++' symlinks that are
available on many systems.
2023-10-03 21:55:24 -04:00
Ray Speth
2693de689d [CI] Pin MinGW verision
Fixes failing builds, pending updates to the setup-mingw action
2023-10-03 21:55:24 -04:00
Ray Speth
0fa08af2a5 [CI] Fix clang builds on Ubuntu 22.04
GitHub Actions runner was updated to remove Clang 12
2023-10-03 21:55:24 -04:00
Ray Speth
3903cacf30 [Examples] Embed fixed temperature file for burner-stabilized flame 2023-10-03 11:23:39 -04:00
Ray Speth
5dacf66bda [Examples] Make author acknowledgments more consistent 2023-10-03 11:23:39 -04:00
Ray Speth
7ac1b9d780 Set order of sample sub-galleries 2023-10-03 11:23:39 -04:00
Ray Speth
e0fb411ae2 [CI] Save Sphinx docs artifact even if there were warnings 2023-10-03 11:23:39 -04:00
Ray Speth
553d5def17 [SCons] Use logging option to adjust Sphinx logging 2023-10-03 11:23:39 -04:00
Ray Speth
6f95c67936 [Doc,CI] Update keyword checking for new syntax 2023-10-03 11:23:39 -04:00
Ray Speth
4de36cb629 [CI] Handle building examples with sphinx-gallery 2023-10-03 11:23:39 -04:00
Ray Speth
d959103237 [Doc] Add separate top-level pages for examples and reference docs 2023-10-03 11:23:39 -04:00
Ray Speth
899b354572 Generate plots for examples where this requires the --plot option 2023-10-03 11:23:39 -04:00
Ray Speth
faadf015ee Add Matlab examples to sphinx-gallery 2023-10-03 11:23:39 -04:00
Ray Speth
6eb4f08907 Add clib example to sphinx-gallery 2023-10-03 11:23:39 -04:00
Ray Speth
732e7e89fa Add Fortran examples to sphinx-gallery 2023-10-03 11:23:39 -04:00
Ray Speth
f720a573db [Doc] Add C++ examples to sphinx-gallery 2023-10-03 11:23:39 -04:00
Ray Speth
c49c95d666 [Doc] Add remaining Python examples to sphinx-gallery
Introduce a monkey patch to avoid executing specific examples that
won't run under sphinx-gallery.
2023-10-03 11:23:39 -04:00