NotificationsYou must be signed in to change notification settings
Fork673
Star2.4k

Commit1ac66bc

Gauvain Pocentek

committed

Update API docs for v4

1 parent746846c commit1ac66bcCopy full SHA for 1ac66bc

File tree

2 files changed

+33

-5

lines changed

docs
- api
  - gitlab.rst
- ext
  - docstrings.py

2 files changed

+33

-5

lines changed

`‎docs/api/gitlab.rst`

Lines changed: 29 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -11,18 +11,34 @@ Module contents`
`11`	`11`	`:exclude-members: Hook, UserProject, Group, Issue, Team, User,`
`12`	`12`	`all_projects, owned_projects, search_projects`
`13`	`13`
`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`
`15`	`23`	`------------------------`
`16`	`24`
`17`		`-..automodule::gitlab.exceptions`
	`25`	`+..automodule::gitlab.v3.objects`
`18`	`26`	`:members:`
`19`	`27`	`:undoc-members:`
`20`	`28`	`: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`
`21`	`37`
`22`		`-gitlab.objects module`
`23`		`----------------------`
	`38`	`+gitlab.v4.objects module`
	`39`	`+------------------------`
`24`	`40`
`25`		`-..automodule::gitlab.objects`
	`41`	`+..automodule::gitlab.v4.objects`
`26`	`42`	`:members:`
`27`	`43`	`:undoc-members:`
`28`	`44`	`:show-inheritance:`
`@@ -34,3 +50,11 @@ gitlab.objects module`
`34`	`50`	`requiredCreateAttrs, optionalCreateAttrs,`
`35`	`51`	`requiredUpdateAttrs, optionalUpdateAttrs, getRequiresId,`
`36`	`52`	`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`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+importinspect`
`1`	`2`	`importitertools`
`2`	`3`	`importos`
`3`	`4`
`@@ -9,7 +10,10 @@`
`9`	`10`
`10`	`11`
`11`	`12`	`defclassref(value,short=True):`
	`13`	`+ifnotinspect.isclass(value):`
	`14`	`+return':class:%s'%value`
`12`	`15`	`tilde='~'ifshortelse''`
	`16`	`+string='%s.%s'% (value.__module__,value.__name__)`
`13`	`17`	return':class:`%sgitlab.objects.%s`'% (tilde,value.__name__)
`14`	`18`
`15`	`19`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit1ac66bc

File tree

2 files changed

2 files changed

`‎docs/api/gitlab.rst`

`‎docs/ext/docstrings.py`

0 commit comments