From 8fd12cf09d4c553491ac6bf7537460490508aee0 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Thu, 17 Nov 2016 19:39:33 -0700 Subject: [PATCH] restructured core_modules --- .../documentation_pages/core_modules.rst | 46 ++++++++++++++++--- 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/package/doc/sphinx/source/documentation_pages/core_modules.rst b/package/doc/sphinx/source/documentation_pages/core_modules.rst index 1e709b99195..39f4ac1d30c 100644 --- a/package/doc/sphinx/source/documentation_pages/core_modules.rst +++ b/package/doc/sphinx/source/documentation_pages/core_modules.rst @@ -11,18 +11,52 @@ the selection definitions and parsing in :mod:`MDAnalysis.core.selection`. -.. rubric:: Contents +Important objects for users +=========================== + +All users of MDAnalysis need to understand the two most important +classes in this section, namely the +:class:`~MDAnalysis.core.universe.Universe` and the +:class:`~MDAnalysis.core.groups.AtomGroup`. .. toctree:: :maxdepth: 1 - core/init core/universe core/groups - core/levels + core/Timeseries + + +Topology system +=============== + +The topology system is primarily of interest to developers. + +.. toctree:: + :maxdepth: 1 + core/topology - core/selection + core/levels core/topologyobjects - core/topologyattrs - core/Timeseries + core/topologyattrs +Selection system +================ + +The selection system is primarily of interest to developers. + +.. toctree:: + :maxdepth: 1 + + core/selection + +Flag system +============ + +The flag system contains the global behavior of MDAnalysis. It is +normally not necessary to change anything here. + +.. toctree:: + :maxdepth: 1 + + core/init