Skip to content

Commit f7bb997

Browse files
DifferentialOrangeDifferentialOrange
committed
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
1 parent 33d18be commit f7bb997

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+3873
-1001
lines changed

‎doc/api/class-connection.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎doc/api/class-mesh-connection.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎doc/api/class-response.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎doc/api/class-space.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎doc/api/submodule-connection-pool.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.connection_pool`
2+
==========================================
3+
4+
.. automodule:: tarantool.connection_pool

‎doc/api/submodule-connection.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.connection`
2+
=====================================
3+
4+
.. automodule:: tarantool.connection

‎doc/api/submodule-dbapi.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.dbapi`
2+
================================
3+
4+
.. automodule:: tarantool.dbapi

‎doc/api/submodule-error.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.error`
2+
================================
3+
4+
.. automodule:: tarantool.error

‎doc/api/submodule-mesh-connection.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.mesh_connection`
2+
==========================================
3+
4+
.. automodule:: tarantool.mesh_connection

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
module :py:mod:`tarantool.msgpack_ext.types`
2+
============================================
3+
4+
.. currentmodule:: tarantool.msgpack_ext.types
5+
6+
module :py:mod:`tarantool.msgpack_ext.types.datetime`
7+
-----------------------------------------------------
8+
9+
.. automodule:: tarantool.msgpack_ext.types.datetime
10+
:special-members: __add__, __sub__, __eq__
11+
12+
13+
.. currentmodule:: tarantool.msgpack_ext.types
14+
15+
module :py:mod:`tarantool.msgpack_ext.types.interval`
16+
-----------------------------------------------------
17+
18+
.. automodule:: tarantool.msgpack_ext.types.interval
19+
:special-members: __add__, __sub__, __eq__

0 commit comments

Comments
 (0)