docs: document hooks API

2 files changed, 70 insertions, 0 deletions

diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
index d03f0d3..112e27b 100644
--- a/docs/gl_objects/projects.py
+++ b/docs/gl_objects/projects.py
@@ -109,3 +109,36 @@ member.delete()
 # share
 project.share(group.id, group.DEVELOPER_ACCESS)
 # end share
+
+# hook list
+hooks = gl.project_hooks.list(project_id=1)
+# or
+hooks = project.hooks.list()
+# end hook list
+
+# hook get
+hook = gl.project_hooks.get(1, project_id=1)
+# or
+hook = project.hooks.get(1)
+# end hook get
+
+# hook create
+hook = gl.project_hooks.create({'url': 'http://my/action/url',
+                                'push_events': 1},
+                               project_id=1)
+# or
+hook = project.hooks.create({'url': 'http://my/action/url', 'push_events': 1})
+# end hook create
+
+# hook update
+hook.push_events = 0
+hook.save()
+# end hook update
+
+# hook delete
+gl.project_hooks.delete(1, project_id=1)
+# or
+project.hooks.delete(1)
+# or
+hook.delete()
+# end hook delete
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index bd56fba..d0c0d27 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -143,3 +143,40 @@ Share the project with a group:
 .. literalinclude:: projects.py
    :start-after: # share
    :end-before: # end share
+
+Hooks
+-----
+
+Use :class:`~gitlab.objects.ProjectHook` objects to manipulate projects
+hooks. The :attr:`gitlab.Gitlab.project_hooks` and :attr:`Project.hooks
+<gitlab.objects.Projects.hooks>` manager objects provide helper functions.
+
+List the project hooks:
+
+.. literalinclude:: projects.py
+   :start-after: # hook list
+   :end-before: # end hook list
+
+Get a project hook
+
+.. literalinclude:: projects.py
+   :start-after: # hook get
+   :end-before: # end hook get
+
+Create a project hook:
+
+.. literalinclude:: projects.py
+   :start-after: # hook create
+   :end-before: # end hook create
+
+Update a project hook:
+
+.. literalinclude:: projects.py
+   :start-after: # hook update
+   :end-before: # end hook update
+
+Delete a project hook:
+
+.. literalinclude:: projects.py
+   :start-after: # hook delete
+   :end-before: # end hook delete