Merge pull request #243 from simphony/add-abcmodelingengine-to-sphinx

Add ABCModelingEngine to sphinx documenation
simphony · Dec 8, 2015 · a1bf079 · a1bf079
2 parents 1431d09 + c894981
commit a1bf079
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/doc/source/api/cuds.rst b/doc/source/api/cuds.rst
@@ -5,16 +5,18 @@ CUDS
 Abstract CUDS interfaces
 ------------------------
 
-.. rubric:: Containers
+.. rubric:: Engine and Containers
 
 .. currentmodule:: simphony.cuds
 
 .. autosummary::
 
+   ~abc_modeling_engine.ABCModelingEngine
    ~abc_mesh.ABCMesh
    ~abc_particles.ABCParticles
    ~abc_lattice.ABCLattice
 
+
 .. rubric:: Description
 
 .. automodule:: simphony.cuds.abc_mesh
@@ -29,6 +31,10 @@ Abstract CUDS interfaces
    :members:
    :undoc-members:
 
+.. automodule:: simphony.cuds.abc_modeling_engine
+   :members:
+   :undoc-members:
+
 Pure Python implementation
 --------------------------
 

diff --git a/doc/source/cuds_definition.rst b/doc/source/cuds_definition.rst
@@ -3,8 +3,8 @@ CUDS Data Structures
 
 The Common Unified Data Structures (CUDS) define the expected
 interface for the modelling engine wrappers, the visualisation api the
-top level CUDS containers (i.e. Mesh, Lattice and Particles) and the
-low level CUDS components (e.g Point, Bond, LatticeNode)
+top-level CUDS containers (i.e. Mesh, Lattice and Particles) and the
+low-level CUDS components (e.g Point, Bond, LatticeNode)
 
 .. note::
 
@@ -19,9 +19,9 @@ Modelling engine
 
   **Figure. 1:** UML description of a CUDS modelling engine.
 
-The CUDS engine supports operations to add, get and remove CUDS
-containers from the internal memory of the engine wrapper to setup
-the SD state of the simulations.
+The CUDS engine (:class:`~.ABCModelingEngine`) supports operations to add,
+get and remove CUDS containers from the internal memory of the engine wrapper
+to setup the SD state of the simulations.
 
 When a CUDS container is added the CUDS modelling engine will copy
 into internal memory only the ``uid`` mapping and the CUBA information
@@ -75,7 +75,7 @@ CUDS Items
 
    **Figure 3:** UML diagram of the CUDS items and their relations.
 
-Low level items are smallest objects that can hold CUBA information in
+Low-level items are the smallest objects that can hold CUBA information in
 SimPhoNy simulations. Each CUDS container supports a specific set of
 these types as presented in **Fig. 2**.
 

diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
@@ -5,10 +5,10 @@ The SimPhoNy library can extended through two `entry points`_ for
 contributing python modules that contain engine and visualisation components:
 
 - ``simphony.engine`` -- A python module that provides one or more
-  classes that implement the :class:`ABCModelingEngine` interface.
+  classes that implement the :class:`~.ABCModelingEngine` interface.
 
 - ``simphony.visualisation`` -- A python module that provides a simple
-  function to show (visualise the high level CUDS containers)
+  function to show (visualise the high-level CUDS containers)
 
 
 To declare that a package contains a visualisation or engine module