Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc updates #728

Merged
merged 2 commits into from
Nov 14, 2023
Merged

doc updates #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ba3fa5
doc updates
mschwamb Nov 10, 2023
37301c1
Merge branch 'main' into nov_doc_changes
mschwamb Nov 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:

Expand Down
8 changes: 1 addition & 7 deletions docs/support.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,8 @@ 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::

Expand Down