Skip to content

sphinx docs for RDF #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kain88-de merged 2 commits into from
Jul 18, 2018
Merged

sphinx docs for RDF #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73d9e43
sphinx docs for RDF
orbeckst Jul 18, 2018
1fea4c4
fix rdf docs
orbeckst Jul 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ also function as examples for how to implement your own functions with

api/rms
api/contacts
api/rdf
2 changes: 2 additions & 0 deletions docs/api/rdf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: pmda.rdf

13 changes: 7 additions & 6 deletions pmda/rdf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down