diff --git a/docs/app.rst b/docs/app.rst index 22f0ade8fda1958a7f02144a01cc6371074ce960..dbf1bf44cefe0e8c0e93341a1bc9ed6cb0c2a5cd 100644 --- a/docs/app.rst +++ b/docs/app.rst @@ -37,7 +37,7 @@ Contents of `config.yml`:: max_inflight: 64 message_serializer: 'goblin.driver.GraphSONMessageSerializer' -Special :py:mod:`Goblin` App Configuration +Special :py:mod:`Goblin<goblin>` App Configuration -------------------------------------------------------------- :py:class:`Goblin<goblin.app.Goblin>` supports two additional configuration @@ -70,4 +70,5 @@ its values to produces a hashable id:: ... id_hash = functools.reduce(operator.xor, hashes, 0) ... return id_hash -Look for provider specific :py:mod:`Goblin` libraries in the near future! +Look for provider specific :py:mod:`Goblin<goblin>` libraries in the near +future! diff --git a/docs/conf.py b/docs/conf.py index 277fcf2ca4a69e5e853d2c40f772775b34ee1027..70f1ed98fcad2a267129dbd64e2783e29b4f1303 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,11 +18,11 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # -import alabaster -import sys import os import shlex +import sys +import alabaster sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) @@ -39,7 +39,7 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', - 'alabaster' + 'alabaster', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/driver.rst b/docs/driver.rst index 6f7e9d66054d74a2bf7a0183c7b977c190ecddc7..c3e8637ec329b6719315fdebc4f5dc58c231a441 100644 --- a/docs/driver.rst +++ b/docs/driver.rst @@ -1,13 +1,13 @@ Using the Driver ================ -Connecting to a :py:class:`Cluster<goblin.driver.cluster.Cluster>` ------------------------------------------------------------------- +Connecting to a :py:class:`Cluster<goblin.driver.Cluster>` +---------------------------------------------------------- To take advantage of the higher level features of the -:py:mod:`driver<goblin.driver>`, :py:mod:`Goblin` provides the -:py:class:`Cluster<goblin.driver.cluster.Cluster>` object. -:py:class:`Cluster<goblin.driver.cluster.Cluster>` is used to create multi-host +:py:mod:`driver<goblin.driver>`, :py:mod:`~goblin.app.Goblin` provides the +:py:class:`Cluster<goblin.driver.Cluster>` object. +:py:class:`Cluster<goblin.driver.Cluster>` is used to create multi-host clients that leverage connection pooling and sharing. Its interface is based on the TinkerPop Java driver:: @@ -18,19 +18,19 @@ on the TinkerPop Java driver:: ... print(msg) >>> await cluster.close() # Close all connections to all hosts -And that is it. While :py:class:`Cluster<goblin.driver.cluster.Cluster>` +And that is it. While :py:class:`Cluster<goblin.driver.Cluster>` is simple to learn and use, it provides a wide variety of configuration options. -Configuring :py:class:`Cluster<goblin.driver.cluster.Cluster>` +Configuring :py:class:`Cluster<goblin.driver.Cluster>` -------------------------------------------------------------- Configuration options can be set on -:py:class:`Cluster<goblin.driver.cluster.Cluster>` in one of two ways, either +:py:class:`Cluster<goblin.driver.Cluster>` in one of two ways, either passed as keyword arguments to -:py:meth:`open<goblin.driver.cluster.Cluster.open>`, or stored in a configuration -file and passed to the :py:meth:`open<goblin.driver.cluster.Cluster.open>` +:py:meth:`open<goblin.driver.Cluster.open>`, or stored in a configuration +file and passed to the :py:meth:`open<goblin.driver.Cluster.open>` using the kwarg `configfile`. Configuration files can be either YAML or JSON -format. Currently, :py:class:`Cluster<goblin.driver.cluster.Cluster>` +format. Currently, :py:class:`Cluster<goblin.driver.Cluster>` uses the following configuration: +-------------------+----------------------------------------------+-------------+ @@ -70,7 +70,7 @@ uses the following configuration: +-------------------+----------------------------------------------+-------------+ |message_serializer |String denoting the class used for message |'classpath' | | |serialization, currently only supports | | -| |basic GraphSONMessageSerializer | | +| |basic GraphSONMessageSerializer | | +-------------------+----------------------------------------------+-------------+ diff --git a/docs/glv.rst b/docs/glv.rst index 6bddf240abba1fcf06d846bbe241b22cec604e01..30e3b9396275c1f794bbc2ac37b822a22cf9d9f9 100644 --- a/docs/glv.rst +++ b/docs/glv.rst @@ -1,7 +1,7 @@ Using Graph (GLV) ================= -:py:mod:`Goblin` provides access to the underlying :py:mod:`aiogremlin` +:py:mod:`~goblin.app.Goblin` provides access to the underlying :py:mod:`aiogremlin` asynchronous version of the Gremlin-Python Gremlin Language Variant (GLV) that is bundled with Apache TinkerPop beginning with the 3.2.2 release. Traversals are generated using the class diff --git a/docs/goblin.driver.rst b/docs/goblin.driver.rst index 8536488ee2fa4595fe4a8726f066bcf193db266b..98197d5cff0528a61c02cbbb869628f10e87fb80 100644 --- a/docs/goblin.driver.rst +++ b/docs/goblin.driver.rst @@ -1,13 +1,12 @@ goblin.driver package ===================== -Contains aliases to classes from :py:mod:`aiogremlin`: - -- :py:class:`Cluster<aiogremlin.driver.cluster.Cluster>` -- :py:class:`Graph<aiogremlin.structure.graph.Graph>` -- :py:class:`DriverRemoteConnection<aiogremlin.remote.driver_remote_connection.DriverRemoteConnection>` -- :py:class:`Client<aiogremlin.driver.client.Client>` -- :py:class:`Connection<aiogremlin.driver.connection.Connection>` -- :py:class:`ConnectionPool<aiogremlin.driver.pool.ConnectionPool>` -- :py:class:`GremlinServer<aiogremlin.driver.server.GremlinServer>` -- :py:class:`GraphSONMessageSerializer<gremlin_python.driver.serializer.GraphSONMessageSerializer>` +Contains aliases to classes from `aiogremlin`: + +.. automodule:: goblin.driver + +.. autoclass:: goblin.driver.Cluster + :members: + +.. autoclass:: goblin.driver.Connection + :members: