Bryan W. Weber
f0bb0f8492
[Doc] Fix some Sphinx warnings
...
Comments are also added to note places where the function
signatures embedded by Cython produce warnings in Sphinx.
These warnings should be ignored until Sphinx supports this.
2014-08-26 22:04:59 +00:00
Ray Speth
71cabc86ef
[SCons] Express dependencies for rebuilding Doxygen documentation
2014-08-25 22:18:56 +00:00
Harry Moffat
0d9b7d7868
Updated doxygen make generation capability.
...
Started to modify doxygen content to get rid of the large number of warnings.
2014-08-21 00:48:04 +00:00
Harry Moffat
81556ea8aa
Rewrite of InterfaceKinetics - next iteration.
2014-08-14 00:00:00 +00:00
Harry Moffat
6741d8f7c6
InterfaceKinetics rewrite -> addition of general BV reactions and affinity formulation.
2014-08-12 23:02:47 +00:00
Ray Speth
7ebfbed486
[Doc] Add note about required SCons version for VS2013
2014-07-30 16:59:36 +00:00
Ray Speth
6c3867ca79
[SCons] Let SCons choose the default version of MSVC
...
The near-requirement of using the same version of MSVC as Python was compiled
with has been relaxed by the move to compiling the Python extension in SCons
rather than letting Distutils do it.
2014-07-25 18:33:02 +00:00
Ray Speth
b141760015
[Doc] Update instructions for checking out the code
2014-07-25 18:33:00 +00:00
Ray Speth
93719f0261
[Doc] Fix syntax highlighting in CTI guide
2014-07-25 18:32:47 +00:00
Ray Speth
a6350348a1
[Doc] Fix 'currentmodule' directive for ctml_writer functions
2014-07-25 18:32:42 +00:00
Ray Speth
6867381781
[CTI] Document options for controlling mechanism validation
...
Add documentation for the validate() function, and remove documentation
for the non-existent 'no_validation' flag.
2014-07-25 18:32:39 +00:00
Bryan W. Weber
cd8e9242a6
[Doc] Allow differentiation of classes from functions in the Matlab docs
2014-07-18 14:37:42 +00:00
Bryan W. Weber
c6ac27b07c
[Doc/Matlab] Add documentation for all Matlab functions
2014-07-18 14:35:41 +00:00
Bryan W. Weber
f4041d6fb2
[Doc] Add the ability to pseudo-autodocument MATLAB code to the SConscript file
2014-07-18 14:32:53 +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
c7e2f5fcbc
[Doc] Add recommended citation for Cantera
2014-07-10 22:33:25 +00:00
Ray Speth
2b9f3b9913
Remove unused Doxygen input files
2014-06-10 16:21:37 +00:00
Ray Speth
d3667cae3c
[Doc] Fix reference that wasn't being parsed correctly
2014-06-03 16:52:22 +00:00
Ray Speth
fb588d873b
Remove deprecated / unfinished 'spectra' classes
2014-05-30 19:23:37 +00:00
Ray Speth
f85e49a87b
[Doc] Update methods for doing manual cti to ctml conversions
2014-05-29 18:34:38 +00:00
Ray Speth
9ff22eebc5
[Doc] Update version specified in git/svn checkout commands
2014-04-28 18:18:17 +00:00
Ray Speth
115679ac17
[Doc] Add note about how to fix Sundials CMakeLists.txt
...
The Sundials CMakeLists.txt was not correctly updated for the 2.5.0 release, and
builds a version of Sundials that still claims to be 2.4.0. This leads to
compilation errors since some Sundials functions have changed signatures between
2.4 and 2.5, and Canteran needs to distinguish between the two.
2014-04-14 18:37:43 +00:00
Ray Speth
d2ff7dbaaa
[SCons] 'clean' removes auto-generated .rst files from examples
2014-04-08 16:26:11 +00:00
Ray Speth
b2c050e545
[Doc] Add FAQ on debugging compilation issues
2014-03-28 23:12:11 +00:00
Ray Speth
5c99f683df
[SCons] Add 'dump' command line target, and update FAQ
2014-03-28 23:12:06 +00:00
Ray Speth
6266986d7b
[SCons] Add specific targets for building the docs
...
Documentation can be built independently of the code by using the 'scons sphinx'
and 'scons doxygen' commands, as an alternative to using the options
'sphinx_docs=y' and 'doxygen_docs=y' to 'scons build'.
2014-03-13 21:35:39 +00:00
Ray Speth
e09c6ca304
Update compilation instructions
2014-03-13 21:35:32 +00:00
Ray Speth
c7ba8bfb84
Remove abandoned autotools build system
2014-03-04 17:38:53 +00:00
Ray Speth
a313873b03
[Doc] Point to SourceForge for downloads
2014-02-24 03:25:46 +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
f8850963a0
Use b instead of n for temperature exponent
...
Resolves Issue 198.
2014-01-02 22:23:38 +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
Bryan W. Weber
5dddf942c8
[Doc] Add note about specifying species in the stoichiometric_solid example in phases.rst
...
See Issue 196.
2013-12-18 17:46:52 +00:00
Bryan W. Weber
e7e1c7ce6f
[Doc] Fix typo in Chebyshev docs
...
See Issue 196.
2013-12-18 17:46:47 +00:00
Bryan W. Weber
f07e1b6bcd
[Doc] Update Kee reference in SRI formulation
...
See Issue 196.
2013-12-18 17:46:42 +00:00
Bryan W. Weber
f86af29884
[Doc] Add note about specifiying third body efficiencies
...
See Issue 196.
2013-12-18 17:46:37 +00:00
Bryan W. Weber
10cead4950
[Doc] Fix typos and formatting in reactions.rst
...
Add +M to the three-body reaction's reactants.
Update formatting of species names in the following paragraph.
Update formatting of 'units' arguments.
See Issue 196.
2013-12-18 17:46:32 +00:00
Bryan W. Weber
d1fa4395f7
[Doc] Fix typos in thermo parameterizations
...
See Issue 196.
2013-12-18 17:46:21 +00:00
Bryan W. Weber
5698913073
[Doc] Add element class link. Add Kee 1986 transport reference
...
See Issue 196.
2013-12-18 17:46:16 +00:00
Bryan W. Weber
ef23860994
[Doc] Fix typos in doc/sphinx/cti/phases.rst
...
See Issue 196.
2013-12-18 17:46:11 +00:00
Bryan W. Weber
a1ea2a803d
[Doc] Update mixture models docs to support Cantera 2.1
...
See Issue 196.
2013-12-18 17:46:06 +00:00
Bryan W. Weber
87e48fdb6a
[Doc] Fix examples in phases.rst to work with Cantera 2.1
...
See Issue 196.
2013-12-18 17:46:00 +00:00
Bryan W. Weber
5bbe9a6a22
[Doc] Fix typos and formatting in input-files.rst
...
See Issue 196.
2013-12-18 17:45:55 +00:00
Bryan W. Weber
e78d31f933
[Doc] Update formatting of cantera.conf text
...
See Issue 196.
2013-12-18 17:45:50 +00:00
Bryan W. Weber
d7482de464
[Doc] Slight grammar change in FAQ
...
See Issue 196.
2013-12-18 17:45:45 +00:00
Bryan W. Weber
1b6533900e
[Doc] Fix 'git svn clone --std-layout' is not an option error
...
See Issue 196.
2013-12-18 17:45:40 +00:00