Skip to content

Commit

Permalink
[docs] add optional install instructions to contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
luigibonati committed Oct 24, 2023
1 parent 1590bfb commit ea107e2
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ implementation path from the start. Then
cd mlcolvar
pip install -e .
In order to perform the regtests you can install the required packages with:

.. code-block:: bash
pip install mlcolvar[test]
Once your environment is set up you are ready to implement your changes.


Expand Down Expand Up @@ -87,13 +93,19 @@ and simply run
python myfile.py
Finally, when modifying the documentation (especially when using reStructuredText syntax), it is a very good idea to build the
documentation to check the result. To do this you will need to install these additional packages
documentation to check the result. To do this you will need to install these additional packages:

.. code-block:: bash
pip install furo nbsphinx sphinx-copybutton
and then run the commands
or more simply using:

.. code-block:: bash
pip install mlcolvar[doc]
Then, you can build the docs via the command

.. code-block:: bash
Expand Down

0 comments on commit ea107e2

Please sign in to comment.