Add installation to docs (#136)

* add installation.rst * add to index * Update docs/source/installation.rst Co-authored-by: Mathias Hauser <[email protected]> * Update docs/source/installation.rst Co-authored-by: Mathias Hauser <[email protected]> * Update docs/source/installation.rst * Update docs/source/installation.rst --------- Co-authored-by: Mathias Hauser <[email protected]>
mpytools · Jan 6, 2025 · 6a15be4 · 6a15be4
1 parent 9672ca9
commit 6a15be4
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,6 +8,13 @@
    :parser: myst_parser.sphinx_
 
 
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: For users
+
+   installation
+
 .. toctree::
    :maxdepth: 2
    :hidden:

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -0,0 +1,25 @@
+Installation
+============
+
+Required dependencies
+---------------------
+
+- Python (3.10 or later)
+- `numpy <http://www.numpy.org/>`__
+- `pandas <https://pandas.pydata.org/>`__
+- `parse <https://pypi.org/project/parse/>`__
+
+Instructions
+------------
+
+filefisher can be installed via conda/mamba:
+
+.. code-block:: bash
+
+    conda install -c conda-forge filefisher
+
+or alternatively, using pip:
+
+.. code-block:: bash
+
+   python -m pip install filefisher