From 4f1b952158b9bbbd8dece1cafde16ed4e4f98741 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 06:58:15 +0200 Subject: [PATCH 1/6] [v4] Fix the jobs manager attribute in Project --- gitlab/v4/objects.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index 03843827f..b86d8bee9 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -1790,7 +1790,7 @@ class Project(GitlabObject): ('boards', 'ProjectBoardManager', [('project_id', 'id')]), ('board_lists', 'ProjectBoardListManager', [('project_id', 'id')]), ('branches', 'ProjectBranchManager', [('project_id', 'id')]), - ('builds', 'ProjectJobManager', [('project_id', 'id')]), + ('jobs', 'ProjectJobManager', [('project_id', 'id')]), ('commits', 'ProjectCommitManager', [('project_id', 'id')]), ('deployments', 'ProjectDeploymentManager', [('project_id', 'id')]), ('environments', 'ProjectEnvironmentManager', [('project_id', 'id')]), From d75e565ca0d4bd44e0e0f4a108e3648e21f799b5 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 06:59:18 +0200 Subject: [PATCH 2/6] move changelog and release notes at the end of index --- docs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a1df804da..219802589 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,14 +11,14 @@ Contents: .. toctree:: :maxdepth: 2 - changelog - release_notes install cli api-usage api-objects upgrade-from-0.10 api/modules + release_notes + changelog Indices and tables From 3ff7d9b70e8bf464706ab1440c87db5aba9c418f Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 07:01:53 +0200 Subject: [PATCH 3/6] Prepare the 0.21.1 release --- ChangeLog.rst | 6 ++++++ gitlab/__init__.py | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/ChangeLog.rst b/ChangeLog.rst index 6d313d613..6e1bc14b7 100644 --- a/ChangeLog.rst +++ b/ChangeLog.rst @@ -1,6 +1,11 @@ ChangeLog ========= +Version 0.21.1_ - 2017-05-25 +---------------------------- + +* Fix the manager name for jobs in the Project class + Version 0.21_ - 2017-05-24 -------------------------- @@ -417,6 +422,7 @@ Version 0.1 - 2013-07-08 * Initial release +.. _0.21.1: https://github.com/python-gitlab/python-gitlab/compare/0.21...0.21.1 .. _0.21: https://github.com/python-gitlab/python-gitlab/compare/0.20...0.21 .. _0.20: https://github.com/python-gitlab/python-gitlab/compare/0.19...0.20 .. _0.19: https://github.com/python-gitlab/python-gitlab/compare/0.18...0.19 diff --git a/gitlab/__init__.py b/gitlab/__init__.py index db96ab31c..e6024a873 100644 --- a/gitlab/__init__.py +++ b/gitlab/__init__.py @@ -35,7 +35,7 @@ from gitlab.v3.objects import * # noqa __title__ = 'python-gitlab' -__version__ = '0.21' +__version__ = '0.21.1' __author__ = 'Gauvain Pocentek' __email__ = 'gauvain@pocentek.net' __license__ = 'LGPL3' From 746846cda9bc18b561a6335bd4951947a74b5bf6 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 07:19:06 +0200 Subject: [PATCH 4/6] Fix broken docs examples --- docs/gl_objects/access_requests.py | 2 +- docs/gl_objects/commits.py | 2 +- docs/gl_objects/issues.rst | 10 +++++----- docs/gl_objects/projects.py | 2 +- docs/gl_objects/snippets.py | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/gl_objects/access_requests.py b/docs/gl_objects/access_requests.py index 2a8c557c5..6497ca1c1 100644 --- a/docs/gl_objects/access_requests.py +++ b/docs/gl_objects/access_requests.py @@ -25,7 +25,7 @@ # approve ar.approve() # defaults to DEVELOPER level ar.approve(access_level=gitlab.MASTER_ACCESS) # explicitly set access level -# approve +# end approve # delete gl.project_accessrequests.delete(user_id, project_id=1) diff --git a/docs/gl_objects/commits.py b/docs/gl_objects/commits.py index 0d47edb9b..befebd54f 100644 --- a/docs/gl_objects/commits.py +++ b/docs/gl_objects/commits.py @@ -27,7 +27,7 @@ commit = gl.project_commits.create(data, project_id=1) # or commit = project.commits.create(data) -# end commit +# end create # get commit = gl.project_commits.get('e3d5a71b', project_id=1) diff --git a/docs/gl_objects/issues.rst b/docs/gl_objects/issues.rst index 27724b8b3..259c79fa6 100644 --- a/docs/gl_objects/issues.rst +++ b/docs/gl_objects/issues.rst @@ -109,29 +109,29 @@ Get time tracking stats: .. literalinclude:: issues.py :start-after: # project issue time tracking stats - :end-before: # end project time tracking stats + :end-before: # end project issue time tracking stats Set a time estimate for an issue: .. literalinclude:: issues.py :start-after: # project issue set time estimate - :end-before: # end project set time estimate + :end-before: # end project issue set time estimate Reset a time estimate for an issue: .. literalinclude:: issues.py :start-after: # project issue reset time estimate - :end-before: # end project reset time estimate + :end-before: # end project issue reset time estimate Add spent time for an issue: .. literalinclude:: issues.py :start-after: # project issue set time spent - :end-before: # end project set time spent + :end-before: # end project issue set time spent Reset spent time for an issue: .. literalinclude:: issues.py :start-after: # project issue reset time spent - :end-before: # end project reset time spent + :end-before: # end project issue reset time spent diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py index 2f8d5b5b2..c9593cc5f 100644 --- a/docs/gl_objects/projects.py +++ b/docs/gl_objects/projects.py @@ -448,4 +448,4 @@ # board lists delete b_list.delete() -# end boards lists delete +# end board lists delete diff --git a/docs/gl_objects/snippets.py b/docs/gl_objects/snippets.py index 091aef60e..f32a11e36 100644 --- a/docs/gl_objects/snippets.py +++ b/docs/gl_objects/snippets.py @@ -4,7 +4,7 @@ # public list public_snippets = gl.snippets.public() -# nd public list +# end public list # get snippet = gl.snippets.get(snippet_id) From 1ac66bc8c36462c8584d80dc730f6d32f3ec708a Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 07:31:34 +0200 Subject: [PATCH 5/6] Update API docs for v4 --- docs/api/gitlab.rst | 34 +++++++++++++++++++++++++++++----- docs/ext/docstrings.py | 4 ++++ 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/docs/api/gitlab.rst b/docs/api/gitlab.rst index 72796eed4..d34d56fc6 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: diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py index 5e5f82fa2..fc95eeb76 100644 --- a/docs/ext/docstrings.py +++ b/docs/ext/docstrings.py @@ -1,3 +1,4 @@ +import inspect import itertools import os @@ -9,7 +10,10 @@ def classref(value, short=True): + if not inspect.isclass(value): + return ':class:%s' % value tilde = '~' if short else '' + string = '%s.%s' % (value.__module__, value.__name__) return ':class:`%sgitlab.objects.%s`' % (tilde, value.__name__) From 4bf251cf94d902e919bfd5a75f5a9bdc4e8bf9dc Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Thu, 25 May 2017 07:32:00 +0200 Subject: [PATCH 6/6] Changelog update --- ChangeLog.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/ChangeLog.rst b/ChangeLog.rst index 6e1bc14b7..306a730a9 100644 --- a/ChangeLog.rst +++ b/ChangeLog.rst @@ -5,6 +5,7 @@ Version 0.21.1_ - 2017-05-25 ---------------------------- * Fix the manager name for jobs in the Project class +* Fix the docs Version 0.21_ - 2017-05-24 --------------------------