Commit graph

346 commits

Author SHA1 Message Date
Ray Speth
02c433b9a2 [Doc/Input] Document phase-level setting for Motz-Wise in YAML files 2019-11-09 11:53:16 -05:00
Ray Speth
6dbcd94029 [Doc] Fix alphabetization of thermo and species thermo models 2019-11-02 10:42:35 -04:00
Ray Speth
71ba021467 Add sticking coefficients to CTI API docs 2019-11-02 10:42:35 -04:00
Bryan W. Weber
55fe2233b1 [Thermo/YAML] Rename water-IAPWS95 to liquid-water-IAPWS95
The water-IAPWS95 instantiates either WaterSSTP or PDSS_water objects,
both of which are intended for liquid phases only. Clarify the phase
name to liquid-water-IAPWS95 to allow a future phase that could
represent the full liquid<->vapor phase space.
2019-10-06 16:45:21 -04:00
Bryan W. Weber
360ac9b79e Copy editing for YAML docs
Improve consistency of formatting. Eliminate duplicate hyperlink targets
by making them anonymous links.
2019-06-25 23:31:23 -04:00
Ray Speth
44c5094bb2 [Input] Implement 'skip-undeclared-third-bodies' option in YAML format 2019-06-25 22:30:59 -04:00
Ray Speth
b77f368ead [Input] Instantiate BinarySolutionTabulatedThermo from YAML 2019-06-25 22:30:59 -04:00
Ray Speth
8eb52a7afb [Input] Create ElectrochemicalReaction objects from YAML definitions 2019-06-25 22:30:59 -04:00
Ray Speth
d66abc5234 [Doc] Add API documentation for the YAML input format 2019-06-25 22:30:59 -04:00
Bryan W. Weber
d25637d0ea
Update NumFOCUS donation link in docs sidebar 2019-03-20 09:15:39 -04:00
Ray Speth
6f45b241b5 Remove code deprecated in Cantera 2.4 2018-12-14 11:27:24 -05:00
Bryan W. Weber
d143e8e1f0
[Doc] Fix documentation header to match main site 2018-09-30 20:19:57 -04:00
band-a-prend
72d2fc4f8c
[SCons/Doc] Fix too long time offline render of Sphinx Docs pages
Add asynchronous ('async', 'media' and conditional 'defer' attributes) loading of remote javascript
and css files within Cantera 2.4.0 Sphinx Documentation to avoid too long render of pages
in case of offline usage of documentation.
2018-09-29 23:21:50 +03:00
Ray Speth
d6da006e3e [SCons] Only build the Python package for Python 3.x 2018-09-19 17:59:59 -04:00
Ray Speth
a54ab2f3ef [Doc] Update docs related to StFlow restructuring 2018-08-10 18:15:36 -04:00
Ray Speth
ac8612f36b [Doc] Add IonFlow and related classes to Sphinx docs 2018-08-10 18:15:36 -04:00
Bryan W. Weber
045f3d37bf [Doc] Fix CSS font specification for Alabaster theme
The font themes must be specified as a string rather than a list.
2018-08-10 11:20:31 -04:00
Bryan W. Weber
4ea9d35a2b Add the CTI API documentation back to the main index page 2018-07-29 17:47:14 -04:00
Bryan W. Weber
3fae1c1a9a Remove pages moved to the new website 2018-07-29 17:47:14 -04:00
Bryan W. Weber
9670c5dac6 Remove most content from Sphinx docs index page
It's all moved elsewhere on the new site.
2018-07-29 17:47:14 -04:00
Bryan W. Weber
dbc3df1687 Switch Sphinx docs to KaTeX instead of MathJax 2018-07-29 17:47:14 -04:00
Bryan W. Weber
e8d28b0e89 Redo layout.html to match the style of and to add links to the main site
We need to replace most of the Sphinx-defaults with things that look
like our new Nikola website and that link to places in the Nikola
website.
2018-07-29 17:47:14 -04:00
Bryan W. Weber
2a7aed8968 Switch to the alabaster theme for API documentation 2018-07-29 17:47:14 -04:00
Bryan W. Weber
3052701250 Remove Mathjax todo that has already been done 2018-07-29 17:47:14 -04:00
Bryan W. Weber
21db5d84f3 Move Matlab docs out of the code-docs subfolder
Now that examples are gone, it's not needed anymore.
2018-07-29 17:47:14 -04:00
Bryan W. Weber
e81cac9582 [Examples] Remove building Matlab examples into the docs
They have moved to the new website
2018-07-29 17:47:14 -04:00
Bryan W. Weber
cc9c8e5633 Remove "Migrating" docs
It's been a few versions since we changed the Python module.
2018-07-29 17:47:14 -04:00
Bryan W. Weber
7b6d04c381 [Examples] Remove building Python examples into the documentation 2018-07-29 17:47:14 -04:00
Ray Speth
b26dc65c41 [Doc] Provide links to docs for old versions of Cantera 2018-05-19 22:04:57 -04:00
Ray Speth
df6ecb101b [Doc] Fix notation for mixture-averaged diffusion coefficient
Flame equations are formulated using Dkm *prime* (Eq. 12.180 from Kee et al),
not plain Dkm (Eq. 12.178).
2018-05-19 22:04:57 -04:00
vishesh devgan
84acdb1a30 [Doc] hydrogen combustion example blank page removed
Resolves #518
2018-05-19 11:01:54 -04:00
Ray Speth
66ba4b5b50 [Doc] Add update of git submodules to code checkout instructions 2018-04-03 09:22:04 -04:00
Ray Speth
3d59914e6f Update version numbers for Cantera 2.4.0
Includes pre-reserved DOI for Zenodo
2018-02-17 16:05:44 -05:00
Bryan W. Weber
66597b72ff
[Doc] Update about page with link to license 2018-02-10 11:53:25 -05:00
Bryan W. Weber
c29fbc808e
[Doc] Add Graphviz to optional documentation dependencies 2018-02-10 11:53:25 -05:00
Bryan W. Weber
1a394a3402
[Doc] Update compiling dependencies
Especially Cython must be installed for Python where SCons is installed
2018-02-10 11:53:25 -05:00
Bryan W. Weber
8195403fef
[Doc] DeCaluwe has a capital C
We don't need any Belgian forebears haunting us
2018-02-10 11:53:25 -05:00
Bryan W. Weber
05fa4df3b9
[Doc] Move citation information out of FAQ to About page 2018-02-10 11:53:24 -05:00
Bryan W. Weber
2abc57e2f1
[Doc] Add 'about' page to docs
Includes info about NumFOCUS sponsorship and donation link, as well as
the steering committee
2018-02-10 11:53:24 -05:00
Bryan W. Weber
c78a11b32f
[Doc] Add that projects can use C language to home page 2018-02-10 11:53:24 -05:00
Bryan W. Weber
0d20b50543
[Doc] Add Donation link to sidebar 2018-02-10 11:53:24 -05:00
Bryan W. Weber
977a1c7736
[Doc] Update Welcome text on homepage 2018-02-10 11:53:24 -05:00
Bryan W. Weber
8caf5e5aca
[Doc] Give the Python and Matlab example index pages more specific names 2018-02-10 11:53:23 -05:00
Bryan W. Weber
581cfb7c04
[Doc] Move Python migrating page to bottom of TOC 2018-02-10 11:53:23 -05:00
Bryan W. Weber
419a09c414
[Doc] Update install instructions in FAQ 2018-02-10 11:53:23 -05:00
Bryan W. Weber
ec5aecd3d6
[Doc] Update example links in FAQ 2018-02-10 11:53:23 -05:00
Bryan W. Weber
e6b4761c6b
Happy New Year! 2018-02-10 11:53:22 -05:00
Bryan W. Weber
e846505f57
[Doc] Use Sphinx Mathjax extension 2018-02-08 16:41:08 -05:00
Bryan W. Weber
46f8ef52a7
Remove MacPorts install instructions from documentation
The MacPorts recipe is broken
2018-01-21 19:44:20 -05:00
Bryan W. Weber
6ca67b4845 Update documentation for new Python configuration options 2017-11-26 16:48:40 -05:00