fixed api docs (#370)

neotime references was changed to neo4j.time

improved the index, conf and driver sections for API docs

Author: martin-neotech

docs/requirements.txt

@@ -1,3 +1 @@
-neotime
 sphinx
-sphinx-rtd-theme

docs/source/conf.py

@@ -39,7 +39,6 @@
     'sphinx.ext.coverage',
     'sphinx.ext.ifconfig',
     'sphinx.ext.intersphinx',
-    "sphinx_rtd_theme",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -57,7 +56,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'Neo4j Bolt Driver for Python'
+project = 'Neo4j Python Driver'
 copyright = '2002-2020, Neo Technology'
 author = 'Neo Technology'
 
@@ -120,8 +119,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-# html_theme = 'nature'
-html_theme = "sphinx_rtd_theme"
+html_theme = 'nature'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -133,7 +131,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "Neo4j Bolt Driver %s for Python" % version
+html_title = "Neo4j Python Driver {}".format(version)
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -305,5 +303,4 @@ def setup(app):
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
-    'neotime': ('https://neotime.readthedocs.io/en/latest/', None),
 }

docs/source/driver.rst

@@ -2,59 +2,67 @@
 Driver Objects
 ==============
 
-Every Neo4j-backed application will require a :class:`.Driver` object.
+Every Neo4j-backed application will require a :class:`neo4j.Driver` object.
 This object holds the details required to establish connections with a Neo4j database, including server URIs, credentials and other configuration.
-:class:`.Driver` objects hold a connection pool from which :class:`.Session` objects can borrow connections.
+:class:`neo4j.Driver` objects hold a connection pool from which :class:`neo4j.Session` objects can borrow connections.
 Closing a driver will immediately shut down all connections in the pool.
 
 Construction
 ============
 
-:class:`.Driver` construction can either be carried out directly or via a `classmethod` on the :class:`.GraphDatabase` class.
+:class:`neo4j.Driver` construction can either be carried out directly or via a `classmethod` on the :class:`neo4j.GraphDatabase` class.
 
 .. autoclass:: neo4j.GraphDatabase
    :members: driver
 
-.. autoclass:: neo4j.Driver(uri, **config)
+.. autoclass:: neo4j.Driver()
    :members: session, close, closed
 
 
 URI
 ===
 
-On construction, the scheme of the URI determines the type of :class:`.Driver` object created.
-Each supported scheme maps to a particular :class:`.Driver` subclass that implements a specific behaviour.
-The remainder of the URI should be considered subclass-specific.
+On construction, the `scheme` of the URI determines the type of :class:`neo4j.Driver` object created.
+
+Example URI::
+
+    uri = bolt://localhost:7676
+
+Example URI::
+
+    uri = neo4j://localhost:7676
+
+Each supported scheme maps to a particular :class:`neo4j.Driver` subclass that implements a specific behaviour.
 
 The alternative behaviours are described in the subsections below.
 
 
-Bolt Direct
------------
+BoltDriver
+----------
 
-URI scheme:
-    ``bolt``
+URI schemes:
+    ``bolt``, ``bolt+ssc``, ``bolt+s``
 Driver subclass:
-    :class:`.BoltDriver`
+    :class:`neo4j.BoltDriver`
 
 .. autoclass:: neo4j.BoltDriver
 
 
-Bolt Routing
+Neo4jDriver
 ------------
 
-URI scheme:
-    ``neo4j``
+URI schemes:
+    ``neo4j``, ``neo4j+ssc``, ``neo4j+s``
 Driver subclass:
-    :class:`.Neo4jDriver`
+    :class:`neo4j.Neo4jDriver`
 
 .. autoclass:: neo4j.Neo4jDriver
 
 
 Configuration
 =============
 
-Additional configuration, including authentication details, can be provided via the :class:`.Driver` constructor.
+Additional configuration, including authentication details, can be provided via the :class:`neo4j.Driver` constructor.
 
 ``auth``
 --------
@@ -71,14 +79,18 @@ Alternatively, one of the auth token functions can be used.
 -------------
 
 A boolean indicating whether or not TLS should be used for connections.
-Defaults to :py:const:`True` if TLS is available.
+
+:Type: ``bool``
+:Default: :py:const:`True`
+
 
 ``trust``
 ---------
 
 The trust level for certificates received from the server during TLS negotiation.
 This setting does not have any effect if ``encrypted`` is set to :py:const:`False`.
 
+
 .. py:attribute:: neo4j.TRUST_ALL_CERTIFICATES
 
    Trust any server certificate (default). This ensures that communication
@@ -92,6 +104,8 @@ This setting does not have any effect if ``encrypted`` is set to :py:const:`Fals
    certificate authority. This option is primarily intended for use with
    full certificates.
 
+:Default: ``neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES``.
+
 ``user_agent``
 --------------
 
@@ -149,7 +163,7 @@ For example::
 Object Lifetime
 ===============
 
-For general applications, it is recommended to create one top-level :class:`.Driver` object that lives for the lifetime of the application.
+For general applications, it is recommended to create one top-level :class:`neo4j.Driver` object that lives for the lifetime of the application.
 For example:
 
 .. code-block:: python
@@ -164,10 +178,10 @@ For example:
         def close(self):
             self.driver.close()
 
-Connection details held by the :class:`.Driver` are immutable.
-Therefore if, for example, a password is changed, a replacement :class:`.Driver` object must be created.
+Connection details held by the :class:`neo4j.Driver` are immutable.
+Therefore if, for example, a password is changed, a replacement :class:`neo4j.Driver` object must be created.
 More than one :class:`.Driver` may be required if connections to multiple databases, or connections as multiple users, are required.
 
-:class:`.Driver` objects are thread-safe but cannot be shared across processes.
+:class:`neo4j.Driver` objects are thread-safe but cannot be shared across processes.
 Therefore, ``multithreading`` should generally be preferred over ``multiprocessing`` for parallel database access.
-If using ``multiprocessing`` however, each process will require its own :class:`.Driver` object.
+If using ``multiprocessing`` however, each process will require its own :class:`neo4j.Driver` object.

docs/source/index.rst

@@ -27,7 +27,55 @@ Python versions supported:
    The driver may still work with older versions of python.
 
    The previous driver `Python Driver 1.7`_ supports older versions of python,
-   the Neo4j 4.0 will work in fallback mode (using Bolt Protocol Version 3) with that driver.
+   the **Neo4j 4.0** will work in fallback mode (using Bolt Protocol Version 3) with that driver.
+
+*************
+Quick Example
+*************
+
+.. code-block:: python
+
+    from neo4j import GraphDatabase
+
+    uri = "bolt://localhost:7687"
+    driver = GraphDatabase.driver(uri, auth=("neo4j", "password"))
+
+    def print_friends_of(tx, name):
+        for record in tx.run("MATCH (a:Person)-[:KNOWS]->(f) "
+                             "WHERE a.name = {name} "
+                             "RETURN f.name", name=name):
+            print(record["f.name"])
+
+    with driver.session() as session:
+        session.read_transaction(print_friends_of, "Alice")
+
+    driver.close()
+
+
+************
+Installation
+************
+
+To install the latest stable driver release, use:
+
+.. code:: bash
+
+    python -m pip install neo4j
+
+
+**Note:** It is always recommended to install python packages for user space in a virtual environment.
+
+.. code:: bash
+
+    python -m venv sandbox
+
+.. code:: bash
+
+    source sandbox/bin/activate
+
+.. code:: bash
+
+    deactivate
 
 
 ****************
@@ -37,23 +85,38 @@ Breaking Changes
 Version Scheme Changes
 ======================
 
-The version number have jumped from :code:`1.7` to :code:`Python Driver 4.0` to align with the Neo4j Database version scheme.
+The version number have jumped from **Python Driver 1.7** to **Python Driver 4.0** to align with the Neo4j Database version scheme.
 
 
 Namespace Changes
 =================
 
-:code:`import neo4j.v1` have changed namespace to be :code:`import neo4j`
+.. code-block:: python
+
+    import neo4j.v1
+
+Have changed to
+
+.. code-block:: python
+
+    import neo4j
 
 
 Secure Connection
 =================
 
-Neo4j 4.0 is by default configured to use a non secure connection.
+**Neo4j 4.0** is by default configured to use a **non secure connection**.
+
+The driver configuration argument :code:`encrypted` is by default set to :code:`False`.
 
-The Driver Configuration argument :code:`encrypted` is by default set to :code:`False`.
+**Note:** To be able to connect to **Neo4j 3.5** set :code:`encrypted=True` to have it configured as the default for that setup.
 
-To be able to connect to Neo4j 3.5 set :code:`encrypted=True` to have it configured as the default for that setup.
+.. code-block:: python
+
+    from neo4j import GraphDatabase
+
+    driver = GraphDatabase("bolt://localhost:7687", auth=("neo4j", "password"), encrypted=True)
+    driver.close()
 
 
 Bookmark Changes
@@ -68,10 +131,10 @@ Exceptions Changes
 The exceptions in :code:`neo4j.exceptions` have been updated and there is internal exceptions starting with the naming :code:`Bolt` that should be propagated into the exceptions API.
 
 
-URI Changes
-===========
+URI Scheme Changes
+==================
 
-`bolt+routing` have been renamed to `neo4j`
+**bolt+routing** have been renamed to **neo4j**.
 
 
 Class Renaming Changes
@@ -99,37 +162,8 @@ Dependency Changes
 The dependency :code:`neobolt` have been removed.
 
 
-*************
-Quick Example
-*************
-
-.. code-block:: python
-
-    from neo4j import GraphDatabase
-
-    uri = "bolt://localhost:7687"
-    driver = GraphDatabase.driver(uri, auth=("neo4j", "password"))
-
-    def print_friends_of(tx, name):
-        for record in tx.run("MATCH (a:Person)-[:KNOWS]->(f) "
-                             "WHERE a.name = {name} "
-                             "RETURN f.name", name=name):
-            print(record["f.name"])
-
-    with driver.session() as session:
-        session.read_transaction(print_friends_of, "Alice")
 
 
-************
-Installation
-************
-
-To install the latest stable driver release, use:
-
-.. code:: bash
-
-    python -m pip install neo4j
-
 
 *****************
 API Documentation

docs/source/types/temporal.rst

@@ -1,23 +1,22 @@
-.. py:currentmodule:: neotime
-
 ===================
 Temporal Data Types
 ===================
 
-Temporal data types are implemented by the `neotime <http://neotime.readthedocs.io/en/latest/>`_ package.
+Temporal data types are implemented by the ``neo4j.time``
+
 These provide a set of types compliant with ISO-8601 and Cypher, which are similar to those found in the built-in ``datetime`` module.
 Sub-second values are measured to nanosecond precision and the types are compatible with `pytz <http://pytz.sourceforge.net/>`_.
 
 The table below shows the general mappings between Cypher and the temporal types provided by the driver.
 In addition, the built-in temporal types can be passed as parameters and will be mapped appropriately.
 
-=============  =========================  ==================================  ============
-Cypher         Python driver type         Python built-in type                ``tzinfo``
-=============  =========================  ==================================  ============
-Date           :class:`neotime:Date`      :class:`python:datetime.date`
-Time           :class:`neotime:Time`      :class:`python:datetime.time`       ``not None``
-LocalTime      :class:`neotime:Time`      :class:`python:datetime.time`       ``None``
-DateTime       :class:`neotime:DateTime`  :class:`python:datetime.datetime`   ``not None``
-LocalDateTime  :class:`neotime:DateTime`  :class:`python:datetime.datetime`   ``None``
-Duration       :class:`neotime:Duration`  :class:`python:datetime.timedelta`
-=============  =========================  ==================================  ============
+=============  ============================  ==================================  ============
+Cypher         Python driver type            Python built-in type                ``tzinfo``
+=============  ============================  ==================================  ============
+Date           :class:`neo4j.time:Date`      :class:`python:datetime.date`
+Time           :class:`neo4j.time:Time`      :class:`python:datetime.time`       ``not None``
+LocalTime      :class:`neo4j.time:Time`      :class:`python:datetime.time`       ``None``
+DateTime       :class:`neo4j.time:DateTime`  :class:`python:datetime.datetime`   ``not None``
+LocalDateTime  :class:`neo4j.time:DateTime`  :class:`python:datetime.datetime`   ``None``
+Duration       :class:`neo4j.time:Duration`  :class:`python:datetime.timedelta`
+=============  ============================  ==================================  ============