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
d62dc233c9
Modify Doxygen navbar to link to Sphinx docs
2023-10-09 16:40:37 -04:00
Ray Speth
6c0b9b80fc
[Doc] Build Sphinx docs and run gallery samples in build dir
...
Sphinx-gallery creates new .rst files alongside existing manually
maintained documentation, and runs the samples in-place, generating
their output files in the source tree. Moving this all to the build
directory lets us keep the repo clean.
2023-10-03 11:23:39 -04:00
Ray Speth
f2cee4f1cc
Bump version to 3.1.0a1
2023-08-26 19:03:02 -07:00
Ray Speth
806842dacc
Bump version to 3.0.0
...
Update link to new DOI on Zenodo
Remove alpha/beta tags from YAML input files so they correspond to this
release version.
2023-08-22 17:34:46 -04:00
Ray Speth
181407d5e5
Adjust ordering of Doxygen pages
...
Move auxiliary pages towards the bottom, and emphasize class documentation
over the "namespace" documentation
2023-08-16 17:10:18 -05:00
Ray Speth
5ee83edca8
Expand trees in Doxygen by default
2023-08-16 17:10:18 -05:00
Ray Speth
7cdba62dac
[Doc] Add BibTeX entries for more references
2023-08-16 17:10:18 -05: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
f902ad82f8
[Doc] Update citations for some transport classes
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
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
0b60e87918
Remove obsolete Doxygen options
...
These options generate warnings with Doxygen 1.9.6
2023-08-07 17:56:56 -05:00
Ingmar Schoegl
bf98c1826a
[docs] Fix LaTeX log/ln/exp
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
d92d977ca9
[docs] Sort BibTeX entries alphabetically
2023-08-06 09:31:37 -05:00
Ingmar Schoegl
9c2441bcfe
[docs] Improve documentation of Kinetics derivatives
2023-08-04 14:01:48 -04:00
Ingmar Schoegl
3478d0e481
[docs] Add Smith and Missen to bibtex
2023-08-03 12:45:31 -05:00
Ingmar Schoegl
b4cde19d61
[docs] Move 1D radiation comments to Doxygen
2023-08-03 12:45:31 -05:00
Ingmar Schoegl
d249b2bfa9
[docs] Add citation
2023-08-03 12:45:31 -05:00
Ingmar Schoegl
e2e5e1b777
[docs] Add spaces between Doxygen and LaTeX commands
2023-08-01 19:22:18 -04:00
Ingmar Schoegl
093ade858f
[docs] Differentiate Doxygen from LaTeX commands
2023-08-01 19:22:18 -04:00
Ingmar Schoegl
5b07e7fb1f
[docs] Make Doxygen style more consistent (con't)
2023-08-01 10:23:06 -04:00
Ingmar Schoegl
4bb6a76723
[docs] Add bibtex hyperlinks to doxygen bibliography
2023-07-28 12:06:47 -06:00
Ingmar Schoegl
fc135d92c6
[docs] Add thermo references
2023-07-28 12:06:47 -06:00
Ingmar Schoegl
e80cbf7f11
[docs] Add kinetics citations
2023-07-28 12:06:47 -06:00
Ingmar Schoegl
a53cd3ae3f
[docs] Add transport references
2023-07-28 12:06:47 -06:00
Ingmar Schoegl
d60383d80b
[docs] Use doxygen cite command
2023-07-28 12:06:47 -06:00
Ingmar Schoegl
a5b704d14c
[docs] Add dev/latest version link
2023-07-28 13:15:21 -04:00
Ingmar Schoegl
c44eee2cde
[docs] Add links to previous Doxygen documentation
2023-07-28 13:15:21 -04:00
Ingmar Schoegl
5f1014c1a0
[docs] Turn off doxygen collaboration diagram
2023-07-19 12:41:01 -04:00
Ingmar Schoegl
90153f74f3
[docs] Customize doxygen menu bar
2023-07-19 12:41:01 -04:00
Ingmar Schoegl
c39135147d
[docs] Add theme extensions
2023-07-19 12:41:01 -04:00
Ingmar Schoegl
978b9e2f25
[docs] Put details on top
...
See https://stackoverflow.com/questions/19831837/documenting-with-doxygen-put-details-on-top
2023-07-19 12:41:01 -04:00
Ingmar Schoegl
1107d7af44
[docs] Switch doxygen theme
2023-07-19 12:41:01 -04:00
Ingmar Schoegl
037d95838a
[docs] Fix formatting
2023-07-17 18:10:24 -06:00
Ingmar Schoegl
e150acfdfb
[docs] Add doxygen treeview
2023-07-17 18:10:24 -06:00
Ingmar Schoegl
17d83034a3
[docs] Restructure doxygen oneD documentation
2023-07-17 18:10:24 -06:00
Ingmar Schoegl
8a94325e75
[docs] Restructure doxygen zeroD documentation
2023-07-17 18:10:24 -06:00
Ingmar Schoegl
591bd7357e
[docs] Improve doxygen group label
2023-07-17 18:10:24 -06:00
Ingmar Schoegl
25e8e5cecd
[docs] Switch to markdown mainfile
...
Supported for doxygen 1.8.3 and later (released 2012)
2023-07-16 11:45:09 -04:00
Ingmar Schoegl
1547e76fc2
[docs] Increate DOT_GRAPH_MAX_NODES
2023-07-16 11:45:09 -04:00
Ray Speth
2771e614f5
Bump version to 3.0.0b1
2023-07-02 09:58:03 -04:00
Ingmar Schoegl
055a530af4
Bump version to 3.0.0a5
2023-04-16 16:29:08 -04:00
Ingmar Schoegl
3d434130bd
Bump version to 3.0.0a4
2023-02-16 13:31:06 -05:00
Ingmar Schoegl
a64d2409ff
Bump version to 3.0.0a3
2022-09-02 08:49:05 -04:00
Ingmar Schoegl
0e627ad28d
Bump version to 3.0.0a2
2022-07-24 18:50:03 -04:00
Ray Speth
a37054cc7f
[Doc] Eliminate CTI/XML-related documentation
2022-05-25 04:02:58 -04:00
Ray Speth
2bd70c8e59
Remove CTI/XML from C++
2022-05-25 04:02:58 -04:00
Ray Speth
Ingmar Schoegl