From 08483a8409cc65f4b18e23b3724779ea9b867770 Mon Sep 17 00:00:00 2001 From: Robsdedude Date: Fri, 22 Nov 2024 10:45:57 +0100 Subject: [PATCH] API Docs: mention Rust extensions in installation section --- docs/source/index.rst | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 81613c26..94e3ff9d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -51,6 +51,18 @@ Topics Installation ************ +.. TODO: 7.0 - remove this note + +.. note:: + + ``neo4j-driver`` is the old name for this package. It is now deprecated and + and will receive no further updates starting with 6.0.0. Make sure to + install ``neo4j`` as shown here. + +.. note:: + + It is always recommended to install python packages for user space in a :ref:`virtual environment `. + To install the latest stable release, use: .. code:: bash @@ -65,18 +77,17 @@ To install the latest pre-release, use: python -m pip install --pre neo4j -.. TODO: 7.0 - remove this note - -.. note:: +Alternative Installation for Better Performance +=============================================== - ``neo4j-driver`` is the old name for this package. It is now deprecated and - and will receive no further updates starting with 6.0.0. Make sure to - install ``neo4j`` as shown above. +You may want to have a look at the available Rust extensions for this driver +for better performance. The Rust extensions are not installed by default. For +more information, see `neo4j-rust-ext`_. -.. note:: +.. _neo4j-rust-ext: https://github.com/neo4j/neo4j-python-driver-rust-ext - It is always recommended to install python packages for user space in a virtual environment. +.. _virtual-environment: Virtual Environment ===================