Skip to content

Commit

Permalink
restructured core_modules
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst committed Nov 18, 2016
1 parent f0a282e commit 8fd12cf
Showing 1 changed file with 40 additions and 6 deletions.
46 changes: 40 additions & 6 deletions package/doc/sphinx/source/documentation_pages/core_modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 8fd12cf

Please sign in to comment.