summaryrefslogtreecommitdiff
path: root/docs/protocol.rst
diff options
Diffstat (limited to 'docs/protocol.rst')
-rw-r--r--docs/protocol.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/protocol.rst b/docs/protocol.rst
new file mode 100644
index 0000000..d79626b
--- /dev/null
+++ b/docs/protocol.rst
@@ -0,0 +1,38 @@
+.. highlight:: rest
+
+.. _protocol_module:
+
+The :mod:`modelcif.protocol` Python module
+==========================================
+
+.. automodule:: modelcif.protocol
+
+.. autoclass:: Step
+ :members:
+
+.. autoclass:: TemplateSearchStep
+ :members:
+
+.. autoclass:: TemplateSelectionStep
+ :members:
+
+.. autoclass:: TargetTemplateAlignmentStep
+ :members:
+
+.. autoclass:: CoevolutionMSAStep
+ :members:
+
+.. autoclass:: ContactPredictionStep
+ :members:
+
+.. autoclass:: ModelingStep
+ :members:
+
+.. autoclass:: ModelSelectionStep
+ :members:
+
+.. autoclass:: ModelRefinementStep
+ :members:
+
+.. autoclass:: Protocol
+ :members: