From 73d9e43466049ec0f42616577bf25e080c9b0121 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Tue, 17 Jul 2018 18:28:33 -0700 Subject: [PATCH 1/2] sphinx docs for RDF --- docs/api.rst | 1 + docs/api/rdf.rst | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 docs/api/rdf.rst diff --git a/docs/api.rst b/docs/api.rst index df64126f..7d2e3668 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -41,3 +41,4 @@ also function as examples for how to implement your own functions with api/rms api/contacts + api/rdf diff --git a/docs/api/rdf.rst b/docs/api/rdf.rst new file mode 100644 index 00000000..b2d1899b --- /dev/null +++ b/docs/api/rdf.rst @@ -0,0 +1,2 @@ +.. automodule:: pmda.rdf + From 1fea4c4cff769d26a8d83a0ddd62c465061570db Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Tue, 17 Jul 2018 20:47:19 -0700 Subject: [PATCH 2/2] fix rdf docs --- pmda/rdf.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/pmda/rdf.py b/pmda/rdf.py index 073b348e..c2b8167d 100644 --- a/pmda/rdf.py +++ b/pmda/rdf.py @@ -8,20 +8,21 @@ # Released under the GNU Public Licence, v2 or any higher version """ Radial Distribution Functions --- :mod:`pmda.rdf` -================================================================ +================================================= This module contains parallel versions of analysis tasks in :mod:`MDAnalysis.analysis.rdf`. -Classes: -------- - -.. autoclass:: InterRDF - See Also -------- MDAnalysis.analysis.rdf + +Classes +------- +.. autoclass:: InterRDF + + """ from __future__ import absolute_import, division