[docs] changed docstring basecv

luigibonati · Oct 24, 2023 · 4e5a2ba · 4e5a2ba
1 parent ea107e2
commit 4e5a2ba
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/docs/autosummary/mlcolvar.cvs.BaseCV.rst b/docs/autosummary/mlcolvar.cvs.BaseCV.rst
@@ -0,0 +1,46 @@
+mlcolvar.cvs.BaseCV
+===================
+
+.. currentmodule:: mlcolvar.cvs
+
+.. autoclass:: BaseCV
+   :members:                                   
+   :show-inheritance:                           
+   :inherited-members: Module,LightningModule                       
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~BaseCV.__init__
+      ~BaseCV.configure_optimizers
+      ~BaseCV.forward
+      ~BaseCV.forward_cv
+      ~BaseCV.initialize_blocks
+      ~BaseCV.initialize_transforms
+      ~BaseCV.parse_options
+      ~BaseCV.setup
+      ~BaseCV.test_step
+      ~BaseCV.validation_step
+
+
+
+
+..
+   
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~BaseCV.example_input_array
+      ~BaseCV.n_cvs
+      ~BaseCV.optimizer_name
+
+
+
+
diff --git a/mlcolvar/cvs/cv.py b/mlcolvar/cvs/cv.py
@@ -4,6 +4,8 @@
 
 class BaseCV:
     """
+    Base collective variable class.
+    
     To inherit from this class, the class must define a BLOCKS class attribute.
     """
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ @@
     class BaseCV:
         """
+        Base collective variable class.
         To inherit from this class, the class must define a BLOCKS class attribute.
         """
@@ Expand Down @@