summaryrefslogtreecommitdiff
path: root/docs/alignment.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/alignment.rst')
-rw-r--r--docs/alignment.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/alignment.rst b/docs/alignment.rst
new file mode 100644
index 0000000..cadcceb
--- /dev/null
+++ b/docs/alignment.rst
@@ -0,0 +1,49 @@
+.. highlight:: rest
+
+.. _alignment_module:
+
+The :mod:`modelcif.alignment` Python module
+===========================================
+
+.. automodule:: modelcif.alignment
+
+.. autoclass:: Identity
+ :members:
+
+.. autoclass:: ShorterSequenceIdentity
+
+.. autoclass:: AlignedPositionsIdentity
+
+.. autoclass:: AlignedResiduePairsIdentity
+
+.. autoclass:: MeanSequenceIdentity
+
+.. autoclass:: Pair
+ :members:
+
+.. autoclass:: AlignmentMode
+ :members:
+
+.. autoclass:: Global
+ :members:
+
+.. autoclass:: Local
+ :members:
+
+.. autoclass:: AlignmentType
+ :members:
+
+.. autoclass:: Pairwise
+ :members:
+
+.. autoclass:: Multiple
+ :members:
+
+.. autoclass:: Score
+ :members:
+
+.. autoclass:: BLASTEValue
+ :members:
+
+.. autoclass:: HHblitsEValue
+ :members: