From 6c037c882f80a288c17e28af35422ecefc403760 Mon Sep 17 00:00:00 2001 From: Oliver Beckstein Date: Fri, 16 Oct 2020 18:28:17 -0700 Subject: [PATCH] add forgotten h-bond analysis docs --- docs/api.rst | 1 + docs/api/hbond_analysis.rst | 1 + pmda/hbond_analysis.py | 2 ++ 3 files changed, 4 insertions(+) create mode 100644 docs/api/hbond_analysis.rst diff --git a/docs/api.rst b/docs/api.rst index 20c0c561..7fe93f2b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -43,6 +43,7 @@ also function as examples for how to implement your own functions with api/rmsd api/rmsf api/contacts + api/hbond_analysis api/rdf api/leaflet api/density diff --git a/docs/api/hbond_analysis.rst b/docs/api/hbond_analysis.rst new file mode 100644 index 00000000..cf59433c --- /dev/null +++ b/docs/api/hbond_analysis.rst @@ -0,0 +1 @@ +.. automodule:: pmda.hbond_analysis diff --git a/pmda/hbond_analysis.py b/pmda/hbond_analysis.py index 82125141..db2ab4d4 100644 --- a/pmda/hbond_analysis.py +++ b/pmda/hbond_analysis.py @@ -13,10 +13,12 @@ This module contains parallel versions of analysis tasks in :mod:`MDAnalysis.analysis.hbonds.hbond_analysis`. + See Also -------- MDAnalysis.analysis.hbonds.hbond_analysis + Classes -------