summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-05-25 07:31:34 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-05-25 07:31:34 +0200
commit1ac66bc8c36462c8584d80dc730f6d32f3ec708a (patch)
tree5cf0a91f3c79d8f75f998b398165bbaff4bdd309 /docs/api
parent746846cda9bc18b561a6335bd4951947a74b5bf6 (diff)
downloadgitlab-1ac66bc8c36462c8584d80dc730f6d32f3ec708a.tar.gz
Update API docs for v4
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/gitlab.rst34
1 files changed, 29 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: