Skip to content

Commit 1ac66bc

Browse files
author
Gauvain Pocentek
committed
Update API docs for v4
1 parent 746846c commit 1ac66bc

File tree

2 files changed

+33
-5
lines changed

2 files changed

+33
-5
lines changed

docs/api/gitlab.rst

+29-5
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,34 @@ Module contents
1111
:exclude-members: Hook, UserProject, Group, Issue, Team, User,
1212
all_projects, owned_projects, search_projects
1313

14-
gitlab.exceptions module
14+
gitlab.base
15+
-----------
16+
17+
.. automodule:: gitlab.base
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
gitlab.v3.objects module
1523
------------------------
1624

17-
.. automodule:: gitlab.exceptions
25+
.. automodule:: gitlab.v3.objects
1826
:members:
1927
:undoc-members:
2028
:show-inheritance:
29+
:exclude-members: Branch, Commit, Content, Event, File, Hook, Issue, Key,
30+
Label, Member, MergeRequest, Milestone, Note, Snippet,
31+
Tag, canGet, canList, canUpdate, canCreate, canDelete,
32+
requiredUrlAttrs, requiredListAttrs, optionalListAttrs,
33+
optionalGetAttrs, requiredGetAttrs, requiredDeleteAttrs,
34+
requiredCreateAttrs, optionalCreateAttrs,
35+
requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId,
36+
shortPrintAttr, idAttr
2137

22-
gitlab.objects module
23-
---------------------
38+
gitlab.v4.objects module
39+
------------------------
2440

25-
.. automodule:: gitlab.objects
41+
.. automodule:: gitlab.v4.objects
2642
:members:
2743
:undoc-members:
2844
:show-inheritance:
@@ -34,3 +50,11 @@ gitlab.objects module
3450
requiredCreateAttrs, optionalCreateAttrs,
3551
requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId,
3652
shortPrintAttr, idAttr
53+
54+
gitlab.exceptions module
55+
------------------------
56+
57+
.. automodule:: gitlab.exceptions
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:

docs/ext/docstrings.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import inspect
12
import itertools
23
import os
34

@@ -9,7 +10,10 @@
910

1011

1112
def classref(value, short=True):
13+
if not inspect.isclass(value):
14+
return ':class:%s' % value
1215
tilde = '~' if short else ''
16+
string = '%s.%s' % (value.__module__, value.__name__)
1317
return ':class:`%sgitlab.objects.%s`' % (tilde, value.__name__)
1418

1519

0 commit comments

Comments
 (0)