diff --git a/docs/source/index.rst b/docs/source/index.rst index 74610c1..0f93073 100644 --- 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 new file mode 100644 index 0000000..728241e --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,25 @@ +Installation +============ + +Required dependencies +--------------------- + +- Python (3.10 or later) +- `numpy `__ +- `pandas `__ +- `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 \ No newline at end of file