From 5c4324fdf873e61901d143b02e9c0de19a37814e Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Mon, 29 Feb 2016 17:27:08 -0800 Subject: [PATCH] added missing function/class docs - closes #746 - added :members: directive --- package/MDAnalysis/analysis/distances.py | 2 +- package/doc/sphinx/source/documentation_pages/analysis/base.rst | 2 ++ .../source/documentation_pages/analysis/lineardensity.rst | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/package/MDAnalysis/analysis/distances.py b/package/MDAnalysis/analysis/distances.py index afc3529d89e..af9d0014648 100644 --- a/package/MDAnalysis/analysis/distances.py +++ b/package/MDAnalysis/analysis/distances.py @@ -25,7 +25,7 @@ :func:`dist` and :func:`between` can take atom groups that do not even have to be from the same :class:`~MDAnalysis.core.AtomGroup.Universe`. -.. SeeAlso:: :mod:`MDAnalysis.lib.distances` and :mod:`MDAnalysis.lib.parallel.distances` +.. SeeAlso:: :mod:`MDAnalysis.lib.distances` """ __all__ = ['distance_array', 'self_distance_array', 'contact_matrix', 'dist'] diff --git a/package/doc/sphinx/source/documentation_pages/analysis/base.rst b/package/doc/sphinx/source/documentation_pages/analysis/base.rst index 84fca34e6f6..4eda92ceac6 100644 --- a/package/doc/sphinx/source/documentation_pages/analysis/base.rst +++ b/package/doc/sphinx/source/documentation_pages/analysis/base.rst @@ -1,2 +1,4 @@ .. automodule:: MDAnalysis.analysis.base + :members: + diff --git a/package/doc/sphinx/source/documentation_pages/analysis/lineardensity.rst b/package/doc/sphinx/source/documentation_pages/analysis/lineardensity.rst index d46d87dff90..2e4b4de2e59 100644 --- a/package/doc/sphinx/source/documentation_pages/analysis/lineardensity.rst +++ b/package/doc/sphinx/source/documentation_pages/analysis/lineardensity.rst @@ -1,2 +1,3 @@ .. automodule:: MDAnalysis.analysis.lineardensity + :members: