Commit graph

26 commits

Author SHA1 Message Date
Ray Speth
0fd419028a [Doc] Add local tables of contents to Reactor and 1D documentation
This makes these pages, which document many classes, easier to navigate.
2014-09-02 22:34:08 +00:00
Bryan W. Weber
47b8c49aed [Doc] Fix names of the physical constants in the Cython documentation 2014-07-16 16:15:21 +00:00
Ray Speth
d2ff7dbaaa [SCons] 'clean' removes auto-generated .rst files from examples 2014-04-08 16:26:11 +00:00
Ray Speth
8471200fc1 [Doc] Add class Mixture to Sphinx docs 2014-02-21 19:07:54 +00:00
Ray Speth
452a9160f0 [Doc] Fix line lengths in Cython migration guide 2014-02-13 22:26:40 +00:00
Ray Speth
bc4d68eb20 [Cython] Add saveState/restoreState info to the migration guide 2014-02-13 22:26:36 +00:00
Ray Speth
22eac2abcd [Sphinx/Cython] Add call signatures to constructors 2014-01-11 00:20:33 +00:00
Bryan W. Weber
421e5356cb [Doc] Fix some formatting in cython/tutorial.rst
See Issue 196.
2013-12-18 17:47:03 +00:00
Bryan W. Weber
6973579b88 [Doc] Correct typo in migrating.rst
See Issue 196.
2013-12-18 17:46:57 +00:00
Ray Speth
12f3b2739c [Doc] Add ideal gas reactor classes to the Sphinx documentation 2013-12-14 00:18:04 +00:00
Ray Speth
d7c939e60c [Cython/Doc] Migration guide covers transport model and Soret effect 2013-11-03 21:06:54 +00:00
Ray Speth
1cedf904df [Doc] Add all Python examples to the Sphinx docs 2013-08-22 21:46:27 +00:00
Ray Speth
e667978655 [Cython] Allow setting state while holding specific properties constant
The value "None" is used to indicate the property or properties being held
constant.
2013-05-31 15:56:36 +00:00
Ray Speth
4743abbe2b [Cython/Doc] Add summary of changes to Python module syntax 2013-05-31 15:56:20 +00:00
Ray Speth
f90d136232 [Doc] Add content from tut[1-4].py to the Sphinx documentation
Update the tutorials to follow the Cython module's syntax
2013-05-31 15:56:01 +00:00
Ray Speth
1352a67e1c [Cython] Added interface for ReactionPathDiagram 2013-05-29 00:11:57 +00:00
Ray Speth
92016a2b31 [Cython] Fixed some problems building the Sphinx documentation 2013-01-30 22:05:46 +00:00
Ray Speth
f53ad9b47b [Cython] Added Sphinx docs for composite classes & importing 2012-12-26 23:56:24 +00:00
Ray Speth
8e355464de [Cython] Added physical constants to Sphinx docs 2012-12-26 23:56:21 +00:00
Ray Speth
8c0c2e16e4 [Cython] Added 1D simulation docs to Sphinx 2012-12-26 23:56:18 +00:00
Ray Speth
2134e5d570 [Cython] Added documentation for Reactor and related classes 2012-10-10 18:25:34 +00:00
Ray Speth
ced2e6c978 [Cython] Generalized interface to Func1
It is now possible to use any callable Python object when the Cantera C++ core
requires an instance of Func1.
2012-10-10 18:25:06 +00:00
Ray Speth
4ff9e61e0d Added docstrings for Cython Transport class 2012-09-06 19:59:58 +00:00
Ray Speth
25f361651a Added docstrings for the Cython Kinetics and InterfaceKinetics classes 2012-09-06 19:59:28 +00:00
Ray Speth
5a722f9608 Added docstrings to Cython ThermoPhase class 2012-09-06 19:58:50 +00:00
Ray Speth
0c904bebfa Added infrastructure for using Sphinx to document the new Python module
This includes adding the sphinx_cmd option to SCons, which can be set to the
Python 3 version of sphinx-build as necessary.
2012-09-06 19:58:13 +00:00