From be83ff9c73d7d8a5807ddce305595ada2b56ba8a Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Sat, 5 Nov 2016 10:57:00 +0100 Subject: 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. --- docs/api/gitlab.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'docs/api') 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 -- cgit v1.2.1