diff options
| -rw-r--r-- | docs/api/gitlab.rst | 34 | ||||
| -rw-r--r-- | docs/ext/docstrings.py | 4 |
2 files changed, 33 insertions, 5 deletions
diff --git a/docs/api/gitlab.rst b/docs/api/gitlab.rst index 72796ee..d34d56f 100644 --- a/docs/api/gitlab.rst +++ b/docs/api/gitlab.rst @@ -11,18 +11,34 @@ Module contents :exclude-members: Hook, UserProject, Group, Issue, Team, User, all_projects, owned_projects, search_projects -gitlab.exceptions module +gitlab.base +----------- + +.. automodule:: gitlab.base + :members: + :undoc-members: + :show-inheritance: + +gitlab.v3.objects module ------------------------ -.. automodule:: gitlab.exceptions +.. automodule:: gitlab.v3.objects :members: :undoc-members: :show-inheritance: + :exclude-members: Branch, Commit, Content, Event, File, Hook, Issue, Key, + Label, Member, MergeRequest, Milestone, Note, Snippet, + Tag, canGet, canList, canUpdate, canCreate, canDelete, + requiredUrlAttrs, requiredListAttrs, optionalListAttrs, + optionalGetAttrs, requiredGetAttrs, requiredDeleteAttrs, + requiredCreateAttrs, optionalCreateAttrs, + requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId, + shortPrintAttr, idAttr -gitlab.objects module ---------------------- +gitlab.v4.objects module +------------------------ -.. automodule:: gitlab.objects +.. automodule:: gitlab.v4.objects :members: :undoc-members: :show-inheritance: @@ -34,3 +50,11 @@ gitlab.objects module requiredCreateAttrs, optionalCreateAttrs, requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId, shortPrintAttr, idAttr + +gitlab.exceptions module +------------------------ + +.. automodule:: gitlab.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py index 5e5f82f..fc95eeb 100644 --- a/docs/ext/docstrings.py +++ b/docs/ext/docstrings.py @@ -1,3 +1,4 @@ +import inspect import itertools import os @@ -9,7 +10,10 @@ from sphinx.ext.napoleon.docstring import GoogleDocstring def classref(value, short=True): + if not inspect.isclass(value): + return ':class:%s' % value tilde = '~' if short else '' + string = '%s.%s' % (value.__module__, value.__name__) return ':class:`%sgitlab.objects.%s`' % (tilde, value.__name__) |