doc updates

make changes to make it clearer for development install instructions
dirac-institute · Nov 10, 2023 · 3ba3fa5 · 3ba3fa5
1 parent 9951715
commit 3ba3fa5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/docs/ephemerisgen.rst b/docs/ephemerisgen.rst
@@ -26,6 +26,7 @@ For each survey visit, the generator calculates the location of the observatory
   For further details, we recommend you read the `ASSIST <https://ui.adsabs.harvard.edu/abs/2023PSJ.....4...69H/abstract>`__ and `REBOUND <https://ui.adsabs.harvard.edu/abs/2012A%26A...537A.128R/abstract>`__ papers. 
 
 .. _MAP:
+
 Massive Asteroid Perturbers
 --------------------------------------------------------
 Here's the list of asteroid pertubers that are included in the ASSIST+REBOUND integrations.

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -79,8 +79,12 @@ If using pip::
 
 .. _dev_mode:
 
-Installing Sorcha in Development Mode or For Updating Documention
+Installing Sorcha in Development Mode
 ---------------------------------------------------------------------
+
+.. tip::
+   This is in the installation method for adding/edit Sorcha's codebase or for working on/updating Sorcha's documentation. 
+
 **Step 1** Create a directory to contain the Sorcha repos::
 
    mkdir sorcha
@@ -105,7 +109,10 @@ If you just want the source code installed so edits in the source code are auomt
 
 If you are going to be editing documentation or significantly modifying unit tests, it is best to install the full development version::
 
-   pip install '.[dev]'
+   pip install -e '.[dev]'
+
+**Step 6 (Optional unless working on documentation):** You will also install the pandoc package (either via conda/pip or `direct download <https://pandoc.org/installing.html>`_ .
+
 
 .. _installation_aux:
 

diff --git a/docs/support.rst b/docs/support.rst
@@ -28,16 +28,10 @@ Contributing to the  Documentation
 
 We are very happy to receivet feedback on the online documentation through the `project's github repository <https://github.com/dirac-institute/sorcha/issues>`_. Beyond pointing out typos and small changes through issues, we welcome pull requests on the `sphinx <https://www.sphinx-doc.org/en/master/#user-guides>`_ documentation used here on the readthedocs.
 
-You will need to install the development version of Sorcha from a clone of the Sorcha repository::
+You will need to install the development version of Sorcha from a clone of the Sorcha repository. See the our  :ref:`dev_mode` instructions for further details. 
 
-   git clone https://github.com/dirac-institute/sorcha.git
 
-
-   pip install '.[dev]' 
-
-You will also  install the pandoc package (either via conda/pip or `direct download <https://pandoc.org/installing.html>`_ . 
-
-If you move to the docs directory (cd sorcha/docs/), edit the *.rst files, and run::
+Once you are properly set up with a clone of the repository, you can move to the docs directory (cd sorcha/docs/), edit the *.rst files, and run::
 
    make html