Commit graph

24 commits

Author SHA1 Message Date
Ray Speth
96ad13e4f8 Moved docs for basic C++ program to Sphinx 2012-03-30 23:46:53 +00:00
Ray Speth
c44ef99775 Added doxylink Sphinx extension for creating links to Doxygen docs 2012-03-30 23:46:48 +00:00
Ray Speth
ed261a2d68 Moved compilation guide to Sphinx 2012-03-30 23:46:42 +00:00
Ray Speth
4ef4c79be9 Rearranged Sphinx sources so it can be used for more general documentation 2012-03-30 23:46:25 +00:00
Ray Speth
b3ae0c9208 Use quotes instead of angle brackets for non-system header #includes 2012-03-15 19:52:16 +00:00
Ray Speth
d573ae6625 Configured Sphinx to use MathJax 2.0 2012-03-15 19:51:09 +00:00
Ray Speth
b4ceb7da2e Reformatted the Python docstrings to work better with Sphinx
This means that the docstrings are now parsed as reStructuredText.
2012-03-13 17:34:47 +00:00
Ray Speth
09d9ded2e7 Added templates for using Sphinx to generate the Python module docs 2012-03-13 17:34:38 +00:00
Ray Speth
c30e7b2c0f Updated compilation instructions 2012-03-13 17:32:25 +00:00
Ray Speth
312b7ff2c4 Deprecated the global "report(ThermoPhase&)" function 2012-03-09 22:57:35 +00:00
Ray Speth
775ed1c609 Moved overview of Phase/Thermophase into the doxygen directory 2012-03-09 22:55:16 +00:00
Ray Speth
54efbaa320 Rewrote exception handling to be more general and more explicit
CanteraError inerits from std:exception, so now it has a what() method
that is used to print a message describing the exception. Adding an
exception to the Cantera error stack now requires explicitly calling
the .save() method.
2012-03-05 20:45:56 +00:00
Ray Speth
8150f49c2c Simplified adding SCons build and install targets 2012-03-05 20:45:20 +00:00
Ray Speth
5be672535a Added documentation note on compiling Sundials with -fPIC 2012-03-01 00:45:08 +00:00
Ray Speth
c7e91eec99 Made Doxygen less obnoxiously verbose 2012-03-01 00:44:42 +00:00
Ray Speth
6a9f3ea892 Marked some unused functions as deprecated 2012-03-01 00:44:31 +00:00
Ray Speth
cf388bde90 Compilation guide updates: OS X, Clang/LLVM, MinGW 2012-02-28 23:48:58 +00:00
Ray Speth
6cb4bd93ce Cleaned up whitespace in all Python files using reindent.py
4 spaces per indentation level, no tabs, no trailing whitespace,
and a single newline at end of each file.
2012-02-27 18:13:05 +00:00
Ray Speth
1ece5bcc3d Some changes to make SCons faster 2012-02-23 21:25:20 +00:00
Ray Speth
46c4baeb8c Updated the C++ samples so that they compile and (mostly) run 2012-02-15 01:01:30 +00:00
Ray Speth
855f2ec77b Eliminated the unnecessary Cantera.h header from sample code 2012-02-15 01:01:15 +00:00
Ray Speth
76c54f4546 Rewrote instructions for compiling Cantera
These instructions reflect the adoption of SCons as the build system
for Cantera on all platforms.
2012-02-13 23:24:29 +00:00
Ray Speth
3ca1eb819e SCons can now build and install the Doxygen-generated documentation 2012-02-13 17:24:44 +00:00
Ray Speth
2528df0f75 Reorganized source tree structure
These changes make it unnecessary to copy header files around during
the build process, which tends to confuse IDEs and debuggers. The
headers which comprise Cantera's external C++ interface are now in
the 'include' directory.

All of the samples and demos are now in the 'samples' subdirectory.
2012-02-12 02:27:14 +00:00