From 4ef4c79be991f4b2be37ea9068b817c401dee83b Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Fri, 30 Mar 2012 23:46:25 +0000 Subject: [PATCH] Rearranged Sphinx sources so it can be used for more general documentation --- doc/sphinx/index.rst | 24 +++++++--------------- doc/sphinx/{ => python}/composite.rst | 0 doc/sphinx/{ => python}/constants.rst | 0 doc/sphinx/{ => python}/convenience.rst | 0 doc/sphinx/{ => python}/error-handling.rst | 0 doc/sphinx/{ => python}/func.rst | 0 doc/sphinx/{ => python}/importing.rst | 0 doc/sphinx/python/index.rst | 23 +++++++++++++++++++++ doc/sphinx/{ => python}/kinetics.rst | 0 doc/sphinx/{ => python}/onedim.rst | 0 doc/sphinx/{ => python}/thermo.rst | 0 doc/sphinx/{ => python}/transport.rst | 0 doc/sphinx/{ => python}/utilities.rst | 0 doc/sphinx/{ => python}/zerodim.rst | 0 14 files changed, 30 insertions(+), 17 deletions(-) rename doc/sphinx/{ => python}/composite.rst (100%) rename doc/sphinx/{ => python}/constants.rst (100%) rename doc/sphinx/{ => python}/convenience.rst (100%) rename doc/sphinx/{ => python}/error-handling.rst (100%) rename doc/sphinx/{ => python}/func.rst (100%) rename doc/sphinx/{ => python}/importing.rst (100%) create mode 100644 doc/sphinx/python/index.rst rename doc/sphinx/{ => python}/kinetics.rst (100%) rename doc/sphinx/{ => python}/onedim.rst (100%) rename doc/sphinx/{ => python}/thermo.rst (100%) rename doc/sphinx/{ => python}/transport.rst (100%) rename doc/sphinx/{ => python}/utilities.rst (100%) rename doc/sphinx/{ => python}/zerodim.rst (100%) diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index d5af0f99b..e17d4bafe 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -1,27 +1,17 @@ .. Cantera documentation master file, created by sphinx-quickstart on Mon Mar 12 11:43:09 2012. -Cantera Python Module Documentation -=================================== - -Contents: +Cantera Documentation +===================== +Contents +======== .. toctree:: :maxdepth: 2 - importing - thermo - kinetics - transport - composite - zerodim - onedim - func - error-handling - constants - utilities - convenience - + python/index + C++ API Documentation + Cantera Development Homepage Indexes ======= diff --git a/doc/sphinx/composite.rst b/doc/sphinx/python/composite.rst similarity index 100% rename from doc/sphinx/composite.rst rename to doc/sphinx/python/composite.rst diff --git a/doc/sphinx/constants.rst b/doc/sphinx/python/constants.rst similarity index 100% rename from doc/sphinx/constants.rst rename to doc/sphinx/python/constants.rst diff --git a/doc/sphinx/convenience.rst b/doc/sphinx/python/convenience.rst similarity index 100% rename from doc/sphinx/convenience.rst rename to doc/sphinx/python/convenience.rst diff --git a/doc/sphinx/error-handling.rst b/doc/sphinx/python/error-handling.rst similarity index 100% rename from doc/sphinx/error-handling.rst rename to doc/sphinx/python/error-handling.rst diff --git a/doc/sphinx/func.rst b/doc/sphinx/python/func.rst similarity index 100% rename from doc/sphinx/func.rst rename to doc/sphinx/python/func.rst diff --git a/doc/sphinx/importing.rst b/doc/sphinx/python/importing.rst similarity index 100% rename from doc/sphinx/importing.rst rename to doc/sphinx/python/importing.rst diff --git a/doc/sphinx/python/index.rst b/doc/sphinx/python/index.rst new file mode 100644 index 000000000..73e97e659 --- /dev/null +++ b/doc/sphinx/python/index.rst @@ -0,0 +1,23 @@ +.. Cantera documentation master file, created by + sphinx-quickstart on Mon Mar 12 11:43:09 2012. + +Python Module Documentation +=========================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + importing + thermo + kinetics + transport + composite + zerodim + onedim + func + error-handling + constants + utilities + convenience diff --git a/doc/sphinx/kinetics.rst b/doc/sphinx/python/kinetics.rst similarity index 100% rename from doc/sphinx/kinetics.rst rename to doc/sphinx/python/kinetics.rst diff --git a/doc/sphinx/onedim.rst b/doc/sphinx/python/onedim.rst similarity index 100% rename from doc/sphinx/onedim.rst rename to doc/sphinx/python/onedim.rst diff --git a/doc/sphinx/thermo.rst b/doc/sphinx/python/thermo.rst similarity index 100% rename from doc/sphinx/thermo.rst rename to doc/sphinx/python/thermo.rst diff --git a/doc/sphinx/transport.rst b/doc/sphinx/python/transport.rst similarity index 100% rename from doc/sphinx/transport.rst rename to doc/sphinx/python/transport.rst diff --git a/doc/sphinx/utilities.rst b/doc/sphinx/python/utilities.rst similarity index 100% rename from doc/sphinx/utilities.rst rename to doc/sphinx/python/utilities.rst diff --git a/doc/sphinx/zerodim.rst b/doc/sphinx/python/zerodim.rst similarity index 100% rename from doc/sphinx/zerodim.rst rename to doc/sphinx/python/zerodim.rst