From 8487f30ea630b0b0d26adda5c03194e38df26309 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 4 Apr 2012 18:46:21 +0000 Subject: [PATCH] Updated the main documentation page --- doc/sphinx/cti/phases.rst | 4 ++-- doc/sphinx/index.rst | 29 +++++++++++++++++++++++------ 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/doc/sphinx/cti/phases.rst b/doc/sphinx/cti/phases.rst index acfe9ab1e..76dfd9a77 100644 --- a/doc/sphinx/cti/phases.rst +++ b/doc/sphinx/cti/phases.rst @@ -27,8 +27,8 @@ gas-electrolyte interfaces, and two metal-electrolyte interfaces. .. figure:: /_static/images/sofc-phases.png :align: center - Phases entering into a hypothetical microkinetic simulation of an idealized - solid-oxide fuel cell. + **Phases entering into a hypothetical microkinetic simulation of an + idealized solid-oxide fuel cell.** How to carry out this fuel cell simulation is beyond the scope of this document; we introduce it here only to give an example of the types of phases and diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 2c3edbc67..b1dcf0ae9 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -1,12 +1,25 @@ .. Cantera documentation master file, created by sphinx-quickstart on Mon Mar 12 11:43:09 2012. -********************* -Cantera Documentation -********************* +******* +Welcome +******* -Contents -======== +Cantera is a suite of object-oriented software tools for problems involving +chemical kinetics, thermodynamics, and/or transport processes. + +Cantera provides types (or classes) of objects representing phases of +matter, interfaces between these phases, reaction managers, time-dependent +reactor networks, and steady one-dimensional reacting flows. Cantera is +currently used for applications including combustion, detonations, +electrochemical energy conversion and storage, fuel cells, batteries, aqueous +electrolyte solutions, plasmas, and thin film deposition. + +Cantera can be used from Python and Matlab, or in applications written +in C++ and Fortran 90. + +Documentation +============= .. toctree:: :maxdepth: 2 @@ -19,7 +32,11 @@ Contents Cantera Development Homepage -* `C++ API Documentation <../../doxygen/html/index.html>`_ +* **C++ Documentation** + + * `Module Organization <../../doxygen/html/modules.html>`_ + * `Index of Classes <../../doxygen/html/classes.html>`_ + * `Deprecation List <../../doxygen/html/deprecated.html>`_ Indexes =======