[cig-commits] [commit] doc_updates: Added solid solution autoclasses to materials.rst (0f29d91)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/burnman

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/eb0f7363a97cf722fd4a257f04c5b28807ac76e8...0f29d91785755799fda918fb6e9685e0c09bc757

>---------------------------------------------------------------

commit 0f29d91785755799fda918fb6e9685e0c09bc757
Author: Bob Myhill <myhill.bob at gmail.com>
Date:   Tue Dec 30 23:15:49 2014 +0000

    Added solid solution autoclasses to materials.rst


>---------------------------------------------------------------

0f29d91785755799fda918fb6e9685e0c09bc757
 burnman/__init__.py  |  1 +
 sphinx/materials.rst | 33 +++++++++++++++++++++++++++------
 2 files changed, 28 insertions(+), 6 deletions(-)

diff --git a/burnman/__init__.py b/burnman/__init__.py
index 74862b4..2280b9a 100644
--- a/burnman/__init__.py
+++ b/burnman/__init__.py
@@ -60,6 +60,7 @@ from version import version as __version__
 from mineral import Mineral
 from material import Material
 from composite import Composite
+from solutionmodel import SolutionModel
 from solidsolution import SolidSolution
 from mineral_helpers import *
 
diff --git a/sphinx/materials.rst b/sphinx/materials.rst
index dd30b46..7de70c7 100644
--- a/sphinx/materials.rst
+++ b/sphinx/materials.rst
@@ -8,18 +8,38 @@ Burnman operates on materials (type :class:`~burnman.material.Material`) most pr
 .. inheritance-diagram:: burnman.Material burnman.Composite burnman.Mineral burnman.solidsolution.SolidSolution burnman.mineral_helpers.HelperSpinTransition
 
 
-Base Material
--------------
+.. inheritance-diagram:: burnman.Material burnman.Composite burnman.Mineral burnman.solutionmodel.SolutionModel burnman.solidsolution.SolidSolution burnman.mineral_helpers.HelperSpinTransition
+
+
+Base Classes
+------------
+
+Materials
+^^^^^^^^^
 
 .. autoclass:: burnman.material.Material
 
+Solution models
+^^^^^^^^^^^^^^^
+
+.. autoclass:: burnman.solutionmodel.SolutionModel
+
 
 Minerals
-----------------------------
+--------
+
+Endmembers
+^^^^^^^^^^
 
 .. autoclass:: burnman.mineral.Mineral
 
-.. autoclass:: burnman.SolidSolution
+Solid solutions
+^^^^^^^^^^^^^^^
+
+.. autoclass:: burnman.solidsolution.SolidSolution
+
+Solid solution helpers (deprecated)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autoclass:: burnman.mineral_helpers.HelperSpinTransition
 
@@ -28,7 +48,8 @@ Minerals
 .. autoclass:: burnman.mineral_helpers.HelperFeDependent
 
 
-Composite
----------
+Composites
+----------
 
 .. autoclass:: burnman.composite.Composite
+