From f775a511c14859cfd2ecc66314837b04a0d2fd0b Mon Sep 17 00:00:00 2001 From: David Fillmore Date: Thu, 2 May 2024 13:51:01 -0600 Subject: [PATCH] Added installation subsection to getting started section. --- docs/source/getting_started.rst | 5 +++++ docs/source/installation.rst | 11 +++++++++++ docs/source/user_guide/index.rst | 9 --------- 3 files changed, 16 insertions(+), 9 deletions(-) create mode 100644 docs/source/installation.rst diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index d112c91f..159b2212 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -2,3 +2,8 @@ Getting Started ############### +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + installation diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 00000000..f44d7b42 --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,11 @@ +Installation +============ + +.. code-block:: console + + $ git clone https://github.com/NCAR/musica.git + $ cd musica + $ mkdir build + $ cd build + $ cmake .. + $ make diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst index a0adf91d..3ac2a7e9 100644 --- a/docs/source/user_guide/index.rst +++ b/docs/source/user_guide/index.rst @@ -1,12 +1,3 @@ ########## User Guide ########## - -.. code-block:: console - - $ git clone https://github.com/NCAR/musica.git - $ cd musica - $ mkdir build - $ cd build - $ cmake .. - $ make