Merge pull request #221 from hmcezar/main

Fix documentation for PLUMED interface
Cascella-Group-UiO · May 12, 2023 · 45a94e7 · 45a94e7
2 parents e3026ca + cf8cb13
commit 45a94e7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/doc_pages/api.rst b/docs/doc_pages/api.rst
@@ -114,3 +114,9 @@ File input/output
 
 .. automodule:: hymd.file_io
    :members:
+
+PLUMED
+------
+
+.. automodule:: hymd.plumed
+   :members:
diff --git a/docs/doc_pages/interfaces.rst b/docs/doc_pages/interfaces.rst
@@ -8,7 +8,7 @@ To use the interface, the Python package of PLUMED must be installed, and the us
 In the current version, only simulations using a single replica are supported.
 
 .. warning::
-PLUMED versions prior to :code:`2.8.1` did not have a working Python interface with MPI. Therefore, you **must** use PLUMED :code:`2.8.1` or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version :code:`2.8.1`.
+   PLUMED versions prior to :code:`2.8.1` did not have a working Python interface with MPI. Therefore, you **must** use PLUMED :code:`2.8.1` or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version :code:`2.8.1`.
 
 Running simulations using PLUMED
 ================================