Skip to content

Commit 4f5ca93

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 4b98136 commit 4f5ca93

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

Diff for: ‎doc/api/class-connection.rst

-10
This file was deleted.

Diff for: ‎doc/api/class-mesh-connection.rst

-8
This file was deleted.

Diff for: ‎doc/api/class-response.rst

-9
This file was deleted.

Diff for: ‎doc/api/class-space.rst

-9
This file was deleted.

Diff for: ‎doc/api/submodule-connection-pool.rst

+4
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

Diff for: ‎doc/api/submodule-connection.rst

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

Diff for: ‎doc/api/submodule-dbapi.rst

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

Diff for: ‎doc/api/submodule-error.rst

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

Diff for: ‎doc/api/submodule-mesh-connection.rst

+4
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

Diff for: ‎doc/api/submodule-msgpack-ext-types.rst

+19
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__

Diff for: ‎doc/api/submodule-msgpack-ext.rst

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
module :py:mod:`tarantool.msgpack_ext`
2+
======================================
3+
4+
.. currentmodule:: tarantool.msgpack_ext
5+
6+
module :py:mod:`tarantool.msgpack_ext.datetime`
7+
-----------------------------------------------
8+
9+
.. automodule:: tarantool.msgpack_ext.datetime
10+
11+
12+
.. currentmodule:: tarantool.msgpack_ext
13+
14+
module :py:mod:`tarantool.msgpack_ext.decimal`
15+
----------------------------------------------
16+
17+
.. automodule:: tarantool.msgpack_ext.decimal
18+
19+
20+
.. currentmodule:: tarantool.msgpack_ext
21+
22+
module :py:mod:`tarantool.msgpack_ext.interval`
23+
-----------------------------------------------
24+
25+
.. automodule:: tarantool.msgpack_ext.interval
26+
27+
28+
.. currentmodule:: tarantool.msgpack_ext
29+
30+
module :py:mod:`tarantool.msgpack_ext.packer`
31+
---------------------------------------------
32+
33+
.. automodule:: tarantool.msgpack_ext.packer
34+
35+
36+
.. currentmodule:: tarantool.msgpack_ext
37+
38+
module :py:mod:`tarantool.msgpack_ext.unpacker`
39+
-----------------------------------------------
40+
41+
.. automodule:: tarantool.msgpack_ext.unpacker
42+
43+
44+
.. currentmodule:: tarantool.msgpack_ext
45+
46+
module :py:mod:`tarantool.msgpack_ext.uuid`
47+
-------------------------------------------
48+
49+
.. automodule:: tarantool.msgpack_ext.uuid

Diff for: ‎doc/api/submodule-request.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.request`
2+
==================================
3+
4+
.. automodule:: tarantool.request

Diff for: ‎doc/api/submodule-response.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.response`
2+
===================================
3+
4+
.. automodule:: tarantool.response

Diff for: ‎doc/api/submodule-schema.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.schema`
2+
=================================
3+
4+
.. automodule:: tarantool.schema

Diff for: ‎doc/api/submodule-space.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.space`
2+
================================
3+
4+
.. automodule:: tarantool.space

Diff for: ‎doc/api/submodule-utils.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module :py:mod:`tarantool.utils`
2+
================================
3+
4+
.. automodule:: tarantool.utils

Diff for: ‎doc/conf.py

+13-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@
2929

3030
# Add any Sphinx extension module names here, as strings. They can be extensions
3131
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig']
32+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
33+
'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx_paramlinks',]
34+
35+
autodoc_default_options = {
36+
'members': True,
37+
'inherited-members': True,
38+
}
3339

3440
# Add any paths that contain templates here, relative to this directory.
3541
templates_path = ['_templates']
@@ -249,7 +255,12 @@
249255

250256

251257
# Example configuration for intersphinx: refer to the Python standard library.
252-
intersphinx_mapping = {'python':('http://docs.python.org/', None)}
258+
intersphinx_mapping = {
259+
'python': ('http://docs.python.org/', None),
260+
'msgpack': ('https://msgpack-python.readthedocs.io/en/latest/', None),
261+
'pandas': ('https://pandas.pydata.org/docs/', None),
262+
'pytz': ('https://pytz.sourceforge.net/', None),
263+
}
253264

254265

255266
autoclass_content = "both"

Diff for: ‎doc/index.rst

+12-4
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,18 @@ API Reference
3939
:maxdepth: 2
4040

4141
api/module-tarantool.rst
42-
api/class-connection.rst
43-
api/class-mesh-connection.rst
44-
api/class-space.rst
45-
api/class-response.rst
42+
api/submodule-connection.rst
43+
api/submodule-connection-pool.rst
44+
api/submodule-dbapi.rst
45+
api/submodule-error.rst
46+
api/submodule-mesh-connection.rst
47+
api/submodule-msgpack-ext.rst
48+
api/submodule-msgpack-ext-types.rst
49+
api/submodule-request.rst
50+
api/submodule-response.rst
51+
api/submodule-schema.rst
52+
api/submodule-space.rst
53+
api/submodule-utils.rst
4654

4755

4856

Diff for: ‎requirements-doc.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
sphinx==5.2.1
2+
sphinx-paramlinks==0.5.4

0 commit comments

Comments
 (0)