summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-11-05 10:57:00 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2016-11-05 10:57:00 +0100
commitbe83ff9c73d7d8a5807ddce305595ada2b56ba8a (patch)
tree87cb07a63a79effaf7c6766f520491f202ed577c /docs/api
parent9f7f45fe2616442d4d05f46fd6d90001ffb12ee6 (diff)
downloadgitlab-be83ff9c73d7d8a5807ddce305595ada2b56ba8a.tar.gz
Rework the API documentation
Update the sphinx extension to add method definition in the docs. This makes the documentation a bit more usable. Hide attributes that should not have been exposed. They still exist in the code but their documentation doesn't make much sense.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/gitlab.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/api/gitlab.rst b/docs/api/gitlab.rst
index 37997be..72796ee 100644
--- a/docs/api/gitlab.rst
+++ b/docs/api/gitlab.rst
@@ -28,4 +28,9 @@ gitlab.objects module
:show-inheritance:
:exclude-members: Branch, Commit, Content, Event, File, Hook, Issue, Key,
Label, Member, MergeRequest, Milestone, Note, Snippet,
- Tag
+ Tag, canGet, canList, canUpdate, canCreate, canDelete,
+ requiredUrlAttrs, requiredListAttrs, optionalListAttrs,
+ optionalGetAttrs, requiredGetAttrs, requiredDeleteAttrs,
+ requiredCreateAttrs, optionalCreateAttrs,
+ requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId,
+ shortPrintAttr, idAttr