From 47e0bd2243f3d41682027347b1a7ca1bcdc6f1e9 Mon Sep 17 00:00:00 2001 From: Adam Schill Collberg Date: Thu, 23 Jan 2025 11:56:01 +0100 Subject: [PATCH] Add content to Installation docs page --- docs/source/installation.rst | 44 +++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 14b533e3..f996833d 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,2 +1,44 @@ Installation ------------- +============ + + +To install the latest version of the library, you can simply run: + +.. code-block:: bash + + pip install neo4j-viz + + +Optional dependencies +--------------------- + +In addition, there are a few optional dependencies that you can install to enable additional features of the library. + + +Pandas `from_dfs` importer +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To install the additional dependencies required for the :doc:`from_dfs importer <./api-reference/from_pandas>` you can run: + +.. code-block:: bash + + pip install neo4j-viz[pandas] + + +Neo4j Graph Data Science `from_gds` importer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To install the additional dependencies required for the :doc:`from_gds importer <./api-reference/from_gds>` you can run: + +.. code-block:: bash + + pip install neo4j-viz[gds] + +Notebook tutorials +~~~~~~~~~~~~~~~~~~ + +To install all the additional dependencies required for the :doc:`notebook examples <./tutorials/index>` you can run: + +.. code-block:: bash + + pip install neo4j-viz[notebook]