doc: describe tarantool submodules API

Add or update docstings for submodule files contents. Submodules are not
meant to be used directly in code, but their descriptions will be
imported automatically to core module API description. It also may
help developers of this module.

Every submodule that could be of use is indexed in documentation now.

Set sphinx autodoc module to describe members and inherited members by
default.

Dataclass with factories display is not parsed correctly, see [1] issue.

1. sphinx-doc/sphinx#10893

Part of #67

doc/api/submodule-connection-pool.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.connection_pool`
+==========================================
+
+.. automodule:: tarantool.connection_pool

doc/api/submodule-connection.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.connection`
+=====================================
+
+.. automodule:: tarantool.connection

doc/api/submodule-dbapi.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.dbapi`
+================================
+
+.. automodule:: tarantool.dbapi

doc/api/submodule-error.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.error`
+================================
+
+.. automodule:: tarantool.error

doc/api/submodule-mesh-connection.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.mesh_connection`
+==========================================
+
+.. automodule:: tarantool.mesh_connection

doc/api/submodule-msgpack-ext-types.rst

@@ -0,0 +1,19 @@
+module :py:mod:`tarantool.msgpack_ext.types`
+============================================
+
+.. currentmodule:: tarantool.msgpack_ext.types
+
+module :py:mod:`tarantool.msgpack_ext.types.datetime`
+-----------------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.types.datetime
+   :special-members: __add__, __sub__, __eq__
+
+
+.. currentmodule:: tarantool.msgpack_ext.types
+
+module :py:mod:`tarantool.msgpack_ext.types.interval`
+-----------------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.types.interval
+   :special-members: __add__, __sub__, __eq__

doc/api/submodule-msgpack-ext.rst

@@ -0,0 +1,49 @@
+module :py:mod:`tarantool.msgpack_ext`
+======================================
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.datetime`
+-----------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.datetime
+
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.decimal`
+----------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.decimal
+
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.interval`
+-----------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.interval
+
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.packer`
+---------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.packer
+
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.unpacker`
+-----------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.unpacker
+
+
+.. currentmodule:: tarantool.msgpack_ext
+
+module :py:mod:`tarantool.msgpack_ext.uuid`
+-------------------------------------------
+
+.. automodule:: tarantool.msgpack_ext.uuid

doc/api/submodule-request.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.request`
+==================================
+
+.. automodule:: tarantool.request

doc/api/submodule-response.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.response`
+===================================
+
+.. automodule:: tarantool.response

doc/api/submodule-schema.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.schema`
+=================================
+
+.. automodule:: tarantool.schema

doc/api/submodule-space.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.space`
+================================
+
+.. automodule:: tarantool.space

doc/api/submodule-utils.rst

@@ -0,0 +1,4 @@
+module :py:mod:`tarantool.utils`
+================================
+
+.. automodule:: tarantool.utils

doc/conf.py

@@ -29,7 +29,13 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
+              'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_paramlinks',]
+
+autodoc_default_options = {
+    'members': True,
+    'inherited-members': True,
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -249,7 +255,12 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python':('http://docs.python.org/', None)}
+intersphinx_mapping = {
+    'python': ('http://docs.python.org/', None),
+    'msgpack': ('https://msgpack-python.readthedocs.io/en/latest/', None),
+    'pandas': ('https://pandas.pydata.org/docs/', None),
+    'pytz': ('https://pytz.sourceforge.net/', None),
+}
 
 
 autoclass_content = "both"

doc/index.rst

@@ -39,10 +39,18 @@ API Reference
    :maxdepth: 2
 
    api/module-tarantool.rst
-   api/class-connection.rst
-   api/class-mesh-connection.rst
-   api/class-space.rst
-   api/class-response.rst
+   api/submodule-connection.rst
+   api/submodule-connection-pool.rst
+   api/submodule-dbapi.rst
+   api/submodule-error.rst
+   api/submodule-mesh-connection.rst
+   api/submodule-msgpack-ext.rst
+   api/submodule-msgpack-ext-types.rst
+   api/submodule-request.rst
+   api/submodule-response.rst
+   api/submodule-schema.rst
+   api/submodule-space.rst
+   api/submodule-utils.rst
 
 
 

requirements-doc.txt

@@ -1 +1,2 @@
 sphinx==5.2.1
+sphinx-paramlinks==0.5.4