Commit 62f8b74e authored by André Anjos's avatar André Anjos 💬

Fix documentation issues

parent cc8c61ca
Pipeline #12323 passed with stages
in 95 minutes and 22 seconds
...@@ -15,5 +15,28 @@ def get_config(): ...@@ -15,5 +15,28 @@ def get_config():
return bob.extension.get_config(__name__) return bob.extension.get_config(__name__)
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, an not on the import module.
Parameters:
*args: An iterable of objects to modify
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
"""
for obj in args: obj.__module__ = __name__
__appropriate__(
Database,
Client,
File,
Protocol,
Model,
)
# gets sphinx autodoc done right - don't remove it # gets sphinx autodoc done right - don't remove it
__all__ = [_ for _ in dir() if not _.startswith('_')] __all__ = [_ for _ in dir() if not _.startswith('_')]
...@@ -58,8 +58,8 @@ class Database(bob.db.base.SQLiteDatabase): ...@@ -58,8 +58,8 @@ class Database(bob.db.base.SQLiteDatabase):
* ``fullLeftMiddle`` * ``fullLeftMiddle``
* ``fullLeftIndex`` * ``fullLeftIndex``
* ``fullRightIndex`` * ``fullRightIndex``
* ``fullRightMiddle` * ``fullRightMiddle``
* ``fullRightRing` * ``fullRightRing``
groups (:py:class:`str`, Optional): ignored (The clients belong both to groups (:py:class:`str`, Optional): ignored (The clients belong both to
``world`` and ``dev``) ``world`` and ``dev``)
...@@ -116,8 +116,8 @@ class Database(bob.db.base.SQLiteDatabase): ...@@ -116,8 +116,8 @@ class Database(bob.db.base.SQLiteDatabase):
* ``fullLeftMiddle`` * ``fullLeftMiddle``
* ``fullLeftIndex`` * ``fullLeftIndex``
* ``fullRightIndex`` * ``fullRightIndex``
* ``fullRightMiddle` * ``fullRightMiddle``
* ``fullRightRing` * ``fullRightRing``
groups (:py:class:`str`, optional): Groups the clients belong to. Should groups (:py:class:`str`, optional): Groups the clients belong to. Should
be one of: be one of:
...@@ -154,8 +154,8 @@ class Database(bob.db.base.SQLiteDatabase): ...@@ -154,8 +154,8 @@ class Database(bob.db.base.SQLiteDatabase):
* ``fullLeftMiddle`` * ``fullLeftMiddle``
* ``fullLeftIndex`` * ``fullLeftIndex``
* ``fullRightIndex`` * ``fullRightIndex``
* ``fullRightMiddle` * ``fullRightMiddle``
* ``fullRightRing` * ``fullRightRing``
groups (:py:class:`str`, optional): Groups the clients belong to. Should groups (:py:class:`str`, optional): Groups the clients belong to. Should
be one of: be one of:
...@@ -205,8 +205,8 @@ class Database(bob.db.base.SQLiteDatabase): ...@@ -205,8 +205,8 @@ class Database(bob.db.base.SQLiteDatabase):
* ``fullLeftMiddle`` * ``fullLeftMiddle``
* ``fullLeftIndex`` * ``fullLeftIndex``
* ``fullRightIndex`` * ``fullRightIndex``
* ``fullRightMiddle` * ``fullRightMiddle``
* ``fullRightRing` * ``fullRightRing``
groups (:py:class:`str`, optional): Groups the clients belong to. Should groups (:py:class:`str`, optional): Groups the clients belong to. Should
be one of: be one of:
...@@ -273,8 +273,8 @@ class Database(bob.db.base.SQLiteDatabase): ...@@ -273,8 +273,8 @@ class Database(bob.db.base.SQLiteDatabase):
* ``fullLeftMiddle`` * ``fullLeftMiddle``
* ``fullLeftIndex`` * ``fullLeftIndex``
* ``fullRightIndex`` * ``fullRightIndex``
* ``fullRightMiddle` * ``fullRightMiddle``
* ``fullRightRing` * ``fullRightRing``
purposes (:py:class:`str`, :py:class:`list`, optional): One or several purposes (:py:class:`str`, :py:class:`list`, optional): One or several
of: of:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment