summaryrefslogtreecommitdiff
path: root/docs/gl_objects/deployments.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-27 23:10:19 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-27 23:10:19 +0200
commit8d7faf42b3e928ead8eb6eb58b7abf94364b53e2 (patch)
treee34834aea728a625c1d5ca1cb5c3e20d61b756cf /docs/gl_objects/deployments.rst
parent40db4cdd24cf31fd6a192b229c132fe28e682eb8 (diff)
downloadgitlab-8d7faf42b3e928ead8eb6eb58b7abf94364b53e2.tar.gz
Add support for project deployments
Diffstat (limited to 'docs/gl_objects/deployments.rst')
-rw-r--r--docs/gl_objects/deployments.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
new file mode 100644
index 0000000..1a679da
--- /dev/null
+++ b/docs/gl_objects/deployments.rst
@@ -0,0 +1,23 @@
+###########
+Deployments
+###########
+
+Use :class:`~gitlab.objects.ProjectDeployment` objects to manipulate project
+deployments. The :attr:`gitlab.Gitlab.project_deployments`, and
+:attr:`Project.deployments <gitlab.objects.Project.deployments>` manager
+objects provide helper functions.
+
+Examples
+--------
+
+List deployments for a project:
+
+.. literalinclude:: deployments.py
+ :start-after: # list
+ :end-before: # end list
+
+Get a single deployment:
+
+.. literalinclude:: deployments.py
+ :start-after: # get
+ :end-before: # end get