Ray Speth
05abe9d361
[Docs] Doxygen no longer inlines inherited documentation
...
As of Doxygen 1.8.0, documentation for inherited member functions is listed in
an expandable section of the derived class's documentation, which seems like a
better compromise.
2013-02-14 01:02:30 +00:00
Ray Speth
7da738d238
Re-applied consistent formatting to trunk
...
Applied using: astyle -n --style=kr --add-brackets --indent=spaces=4
--indent-col1-comments --unpad-paren --pad-header --align-pointer=type
--lineend=linux
2013-02-07 23:40:59 +00:00
Harry Moffat
8793fc3bcb
Doxygen update
...
Doxygen is currently broken. This commit starts to fix some issues.
2013-02-01 18:59:17 +00:00
Ray Speth
92016a2b31
[Cython] Fixed some problems building the Sphinx documentation
2013-01-30 22:05:46 +00:00
Ray Speth
879fd3ed56
Updated Sphinx docs to cover compilation of the Cython module
2012-12-26 23:56:30 +00:00
Ray Speth
e80d5bbbb9
Fixed an error in the CTI guide
2012-12-26 23:56:28 +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
1d19803885
Pass "const std::string&" instead of "std::string" when possible
2012-10-24 15:42:51 +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
13d916862e
Updated compilation instructions to cover the new Python module
2012-09-06 19:58:44 +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
Ray Speth
42e07afedc
Removed remnants of pydoc-style documentation
2012-09-06 19:58:08 +00:00
Nicholas Malaya
1e2e31ba16
updating the file include path
2012-08-17 21:23:37 +00:00
Ray Speth
021f66c755
Merge bug fixes from the 2.0 maintenance branch
2012-08-15 15:36:34 +00:00
Ray Speth
ead04df741
Updated docs to indicate that blas_lapack_libs is unnecessary on OS X
2012-08-12 23:00:14 +00:00
Ray Speth
88bb6fe679
Removed obsolete C++ Chemkin mechanism converter
2012-07-26 20:49:50 +00:00
Nicholas Malaya
521b2957c9
missing a makefile.am, somehow
2012-07-19 15:41:54 +00:00
Nicholas Malaya
198d1adda7
fixing a few missed files that needed to be included
2012-07-19 15:39:55 +00:00
Nicholas Malaya
8d802d1616
[cantera]: fixing doxygen documentation test generation.
2012-07-19 15:32:34 +00:00
Nicholas Malaya
ab4e791ba8
updating doxygen files to try to get this guy working
2012-07-18 23:34:10 +00:00
Nicholas Malaya
e25c671ee8
fixing up doxygen documentation
2012-07-18 23:28:05 +00:00
Ray Speth
5bb6edb133
Bump version number of development version (trunk)
2012-07-10 16:25:39 +00:00
Ray Speth
58c202395c
Bump version to 2.0.0 (final)
2012-07-10 16:23:12 +00:00
Nicholas Malaya
c9169033ff
[cantera2.0]: missing makefile.am, added
2012-06-19 15:24:56 +00:00
Nicholas Malaya
35afd04dfa
[cantera2.0]: fixing various other directories related to doxygen building
2012-06-19 14:32:37 +00:00
Ray Speth
1a60d55135
Added support for SRI falloff parameterization to ck2cti.py
2012-06-15 21:56:49 +00:00
Ray Speth
f49ce03f88
Added documentation on using pkg-config
2012-06-14 21:06:46 +00:00
Ray Speth
61fce224af
Updated compilation / installation documentation
2012-06-14 21:06:23 +00:00
Ray Speth
f3c3f47bc5
Incremented version number (2.0.0b3)
2012-06-05 19:56:26 +00:00
Ray Speth
cc042e088f
Enabled class Adsorbate
2012-05-31 14:57:49 +00:00
Ray Speth
55ef0f3c73
Removed some unimplemented configuration options
2012-05-31 14:57:44 +00:00
Ray Speth
6011f24b38
Removed unnecessary WITH_FEATURE configuration options
2012-05-31 14:57:32 +00:00
Ray Speth
cddd2ec724
Updated some documentation for using the Intel compiler and MKL
2012-05-29 21:22:30 +00:00
Ray Speth
ba8acd41e0
Updated documentation for Phase/ThermoPhase class heirarchy
...
Removed some redundant documentation and fixed references to the no
longer existent Constituent and State classes.
2012-05-29 18:03:35 +00:00
Ray Speth
bdac195cb0
Added input file documentation for Chebyshev and P-log rate expressions
2012-05-29 18:03:31 +00:00
Ray Speth
a78755b971
Fixed some undefined references in the CTI documentation
2012-05-18 22:42:03 +00:00
Ray Speth
754faa3b13
Added option to ignore third-body efficiencies for undeclared species
...
To enable this option, in the phase definition, add
'skip_undeclared_third_bodies' to the list passed as the 'options'
argument.
2012-05-18 22:41:58 +00:00
Ray Speth
59a2c4c251
Note requirement of WiX for building MSI installers
2012-04-26 21:20:04 +00:00
Ray Speth
88bcc81b57
Updated the Compilation Guide
2012-04-19 16:45:24 +00:00
Ray Speth
8487f30ea6
Updated the main documentation page
2012-04-04 18:46:21 +00:00
Ray Speth
095f43c1eb
Added modified CSS for Sphinx documentation
...
This CSS (from Matplotlib) adds thick lines before each documented
class and thin lines at the start of each documented method.
2012-04-04 18:46:16 +00:00
Ray Speth
3938a6bfa7
Moved Matlab input tutorial into Sphinx documentation
2012-04-04 18:46:11 +00:00
Ray Speth
545e258eb3
Moved more general documentation to ReST/Sphinx
2012-04-04 18:46:02 +00:00
Ray Speth
0d991f5251
Removed some obsolete documentation
2012-04-04 18:45:53 +00:00