WIP on long-form documentation

#69
oncoray · Mar 27, 2024 · e3ab0eb · e3ab0eb
1 parent e11d6f6
commit e3ab0eb
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 14 deletions.
diff --git a/docs_source/source/mirp.settings.rst → docs_source/source/configuration.rst b/docs_source/source/mirp.settings.rst → docs_source/source/configuration.rst
diff --git a/...source/mirp.deepLearningPreprocessing.rst → docs_source/source/deep_learning.rst b/...source/mirp.deepLearningPreprocessing.rst → docs_source/source/deep_learning.rst
diff --git a/docs_source/source/mirp.importData.rst → docs_source/source/image_mask_import.rst b/docs_source/source/mirp.importData.rst → docs_source/source/image_mask_import.rst
diff --git a/...ce/source/mirp.extractImageParameters.rst → docs_source/source/image_metadata.rst b/...ce/source/mirp.extractImageParameters.rst → docs_source/source/image_metadata.rst
diff --git a/docs_source/source/index.rst b/docs_source/source/index.rst
@@ -5,12 +5,14 @@ Welcome to MIRP
    :maxdepth: 1
    :caption: Contents:
 
-   mirp.importData
-   mirp.settings
-   mirp.extractImageParameters
-   mirp.extractMaskLabels
-   mirp.deepLearningPreprocessing
-   mirp.extractFeaturesAndImages
+   installation
+   quick_start
+   image_mask_import
+   configuration
+   image_metadata
+   mask_labels
+   deep_learning
+   quantitative_image_analysis
 
 Quick-start
 ===========
@@ -28,11 +30,3 @@ MIRP is available from PyPI and can be installed using ``pip``, or other install
 
 
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs_source/source/installation.rst b/docs_source/source/installation.rst
@@ -0,0 +1,12 @@
+Installing MIRP
+===============
+MIRP is available from `PyPI <https://pypi.org/project/mirp/>`_ and can be installed using ``pip``, or other installer
+tools:
+
+.. code-block:: console
+
+    pip install mirp
+
+.. note::
+    We highly recommend installing MIRP in a virtual environment to avoid dependency issues. For more information
+    see this `primer <https://realpython.com/python-virtual-environments-a-primer/>`_.
diff --git a/..._source/source/mirp.extractMaskLabels.rst → docs_source/source/mask_labels.rst b/..._source/source/mirp.extractMaskLabels.rst → docs_source/source/mask_labels.rst
diff --git a/.../source/mirp.extractFeaturesAndImages.rst → ...ce/source/quantitative_image_analysis.rst b/.../source/mirp.extractFeaturesAndImages.rst → ...ce/source/quantitative_image_analysis.rst
diff --git a/docs_source/source/quick_start.rst b/docs_source/source/quick_start.rst
@@ -0,0 +1,5 @@
+Quick-start
+===========
+
+Before you begin, you need to:
+    1. Install MIRP (see :ref:`installation`).