From 5004cdc67217fed1e56ef250168a75c62cc11021 Mon Sep 17 00:00:00 2001 From: Baudouin Raoult Date: Tue, 28 May 2024 11:14:19 +0100 Subject: [PATCH] Work on documentation --- docs/installing.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/installing.rst b/docs/installing.rst index fe038cc6..7c703b3a 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -1,24 +1,26 @@ -Installing -========== +############ + Installing +############ To install the package, you can use the following command: -.. code-block:: bash +.. code:: bash - pip install anemoi-training + pip install anemoi-training -Contributing ------------- +************** + Contributing +************** -.. code-block:: bash +.. code:: bash - git clone ... - cd anemoi-training - pip install .[dev] - pip install -r docs/requirements.txt + git clone ... + cd anemoi-training + pip install .[dev] + pip install -r docs/requirements.txt You may also have to install pandoc on MacOS: -.. code-block:: bash +.. code:: bash - brew install pandoc + brew install pandoc