Added templates for using Sphinx to generate the Python module docs

SConstruct

@@ -308,8 +308,12 @@ opts.AddVariables(
            Available only when compiling with gcc.""",
         False),
     BoolVariable(
-        'build_docs',
-        """Build HTML documentation using Doxygen""",
+        'doxygen_docs',
+        """Build HTML documentation for the C++ interface using Doxygen""",
+        False),
+    BoolVariable(
+        'sphinx_docs',
+        """Build HTML documentation for the Python module using Sphinx""",
         False),
     BoolVariable(
         'with_lattice_solid',
@@ -1072,7 +1076,7 @@ if env['OS'] != 'Windows':
     VariantDir('build/platform', 'platform/posix', duplicate=0)
     SConscript('build/platform/SConscript')
 
-if env['build_docs']:
+if env['doxygen_docs'] or env['sphinx_docs']:
     SConscript('doc/SConscript')
 
 if 'samples' in COMMAND_LINE_TARGETS or 'install' in COMMAND_LINE_TARGETS:

doc/SConscript

@@ -4,8 +4,16 @@ Import('env', 'build', 'install')
 
 localenv = env.Clone()
 
-build(localenv.Command('#build/docs/html/index.html',
-                       'doxygen/Doxyfile', 'doxygen $SOURCE'))
+if localenv['doxygen_docs']:
+    build(localenv.Command('#build/docs/html/index.html',
+                           'doxygen/Doxyfile', 'doxygen $SOURCE'))
+    install(pjoin('$inst_docdir', 'html'),
+            mglob(localenv, '#/build/docs/html', 'html', 'svg', 'css', 'png'))
 
-install(pjoin('$inst_docdir', 'html'),
-        mglob(localenv, '#/build/docs/html', 'html', 'svg', 'css', 'png'))
+if localenv['sphinx_docs']:
+    localenv['SPHINXBUILD'] = Dir('#build/sphinx')
+    localenv['SPHINXSRC'] = Dir('sphinx')
+
+    build(localenv.Command('${SPHINXBUILD}/html/index.html',
+                           'sphinx/conf.py',
+                           'sphinx-build -b html -d ${SPHINXBUILD}/doctrees ${SPHINXSRC} ${SPHINXBUILD}/html'))

doc/doxygen/scons-options.txt

@@ -124,8 +124,12 @@ of this file is:
     only when compiling with gcc.
     - default: 'no'
 
-* build_docs: [ yes | no ]
-    Build HTML documentation using Doxygen
+* doxygen_docs: [ yes | no ]
+    Build HTML documentation for the C++ interface using Doxygen
+    - default: 'no'
+
+* sphinx_docs: [ yes | no ]
+    Build HTML documentation for the Python module using Sphinx
     - default: 'no'
 
 * with_lattice_solid: [ yes | no ]

doc/sphinx/composite.rst

@@ -0,0 +1,10 @@
+Composite Classes
+=================
+
+These classes are composite representations of a substance which has
+thermodynamic, chemical kinetic, and transport properties.
+
+.. autoclass:: Cantera.Solution
+.. autoclass:: Cantera.Interface.Interface
+.. autoclass:: Cantera.Edge.Edge
+.. autoclass:: Cantera.Mixture

doc/sphinx/conf.py

@@ -0,0 +1,219 @@
+# -*- coding: utf-8 -*-
+#
+# Cantera documentation build configuration file, created by
+# sphinx-quickstart on Mon Mar 12 11:43:09 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../../interfaces/python'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.pngmath',
+              'sphinx.ext.autosummary']
+
+autodoc_default_flags = ['members','show-inheritance','undoc-members']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Cantera'
+copyright = u'2012, Cantera Developers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0.0b1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Canteradoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Cantera.tex', u'Cantera Documentation',
+   u'Cantera Developers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'cantera', u'Cantera Documentation',
+     [u'Cantera Developers'], 1)
+]

doc/sphinx/constants.rst

@@ -0,0 +1,4 @@
+Physical Constants
+==================
+
+.. automodule:: Cantera.constants

doc/sphinx/convenience.rst

@@ -0,0 +1,6 @@
+Convenience Functions
+=====================
+
+.. autofunction:: Cantera.gases.Air
+.. autofunction:: Cantera.gases.Argon
+.. autofunction:: Cantera.gases.GRI30

doc/sphinx/error-handling.rst

@@ -0,0 +1,7 @@
+Error Handling
+==============
+
+.. autofunction:: Cantera.getCanteraError
+
+.. autoexception:: Cantera.exceptions.CanteraError
+.. autoexception:: Cantera.exceptions.OptionError

doc/sphinx/func.rst

@@ -0,0 +1,4 @@
+Func Module
+===========
+
+.. automodule:: Cantera.Func

doc/sphinx/importing.rst

@@ -0,0 +1,8 @@
+Importing Phase Objects
+=======================
+
+.. autofunction:: Cantera.importPhase
+.. autofunction:: Cantera.importPhases
+.. autofunction:: Cantera.importEdge
+.. autofunction:: Cantera.importInterface
+.. autofunction:: Cantera.IdealGasMix

doc/sphinx/index.rst

@@ -0,0 +1,29 @@
+.. Cantera documentation master file, created by
+   sphinx-quickstart on Mon Mar 12 11:43:09 2012.
+
+Cantera Python Module Documentation
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   importing
+   thermo
+   kinetics
+   transport
+   composite
+   zerodim
+   onedim
+   func
+   error-handling
+   constants
+   utilities
+   convenience
+
+Indexes
+=======
+
+* :ref:`genindex`
+* :ref:`search`

doc/sphinx/kinetics.rst

@@ -0,0 +1,4 @@
+Chemical Kinetics
+=================
+
+.. autoclass:: Cantera.Kinetics.Kinetics

doc/sphinx/onedim.rst

@@ -0,0 +1,31 @@
+One-Dimensional Reacting Flows
+==============================
+
+.. automodule:: Cantera.OneD
+
+.. autoclass:: Cantera.OneD.onedim.Domain1D
+.. autofunction:: Cantera.OneD.onedim.clearDomains
+.. autofunction:: Cantera.OneD.onedim.clearSim1D
+
+============
+Flow Domains
+============
+.. autoclass:: Cantera.OneD.onedim.AxisymmetricFlow
+.. autoclass:: Cantera.OneD.StagnationFlow.StagnationFlow
+
+==========
+Boundaries
+==========
+.. autoclass:: Cantera.OneD.onedim.Bdry1D
+.. autoclass:: Cantera.OneD.onedim.Inlet
+.. autoclass:: Cantera.OneD.onedim.Outlet
+.. autoclass:: Cantera.OneD.onedim.OutletRes
+.. autoclass:: Cantera.OneD.onedim.SymmPlane
+
+=================
+Composite Domains
+=================
+.. autoclass:: Cantera.OneD.onedim.Stack
+.. autoclass:: Cantera.OneD.BurnerDiffFlame.BurnerDiffFlame
+.. autoclass:: Cantera.OneD.BurnerFlame.BurnerFlame
+.. autoclass:: Cantera.OneD.CounterFlame.CounterFlame

doc/sphinx/thermo.rst

@@ -0,0 +1,9 @@
+Thermodyamic Properties
+=======================
+
+These classes are used to describe the thermodynamic state of a system.
+
+.. autoclass:: Cantera.Phase.Phase
+.. autoclass:: Cantera.ThermoPhase.ThermoPhase
+.. autoclass:: Cantera.SurfacePhase.EdgePhase
+.. autoclass:: Cantera.SurfacePhase.SurfacePhase

doc/sphinx/transport.rst

@@ -0,0 +1,4 @@
+Transport Properties
+====================
+
+.. autoclass:: Cantera.Transport.Transport

doc/sphinx/utilities.rst

@@ -0,0 +1,7 @@
+Miscellaneous Utilities
+=======================
+
+.. autofunction:: Cantera.addDirectory
+.. autofunction:: Cantera.reset
+.. autofunction:: Cantera.writeCSV
+.. autofunction:: Cantera.writeLogFile

doc/sphinx/zerodim.rst

@@ -0,0 +1,32 @@
+Zero-Dimensional Reactors
+=========================
+
+.. automodule:: Cantera.Reactor
+   :no-members:
+
+============
+Base Classes
+============
+.. autoclass:: Cantera.Reactor.ReactorBase
+.. autoclass:: Cantera.Reactor.Reactor
+.. autoclass:: Cantera.Reactor.FlowDevice
+
+================
+Reactor Networks
+================
+.. autoclass:: Cantera.Reactor.ReactorNet
+
+=============
+Flow Reactors
+=============
+.. autoclass:: Cantera.Reactor.FlowReactor
+.. autoclass:: Cantera.Reactor.ConstPressureReactor
+.. autoclass:: Cantera.Reactor.Reservoir
+
+================
+Flow Controllers
+================
+.. autoclass:: Cantera.Reactor.MassFlowController
+.. autoclass:: Cantera.Reactor.Valve
+.. autoclass:: Cantera.Reactor.PressureController
+.. autoclass:: Cantera.Reactor.Wall