summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-06 14:26:33 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-06 14:26:33 +0200
commite3ac32f76a54e06c9c465c5acd41398988154fe9 (patch)
treefacbe099d8c12626382fe55ea442af35b9332d6a /docs/gl_objects
parente6ffd69bc745ce1a5b857fc248a3bef793e30138 (diff)
parente1f5e1560e53019d45b113a71916ad9a7695afeb (diff)
downloadgitlab-e3ac32f76a54e06c9c465c5acd41398988154fe9.tar.gz
Merge branch 'master' of github.com:gpocentek/python-gitlab
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/namespaces.py7
-rw-r--r--docs/gl_objects/namespaces.rst21
-rw-r--r--docs/gl_objects/runners.rst2
3 files changed, 29 insertions, 1 deletions
diff --git a/docs/gl_objects/namespaces.py b/docs/gl_objects/namespaces.py
new file mode 100644
index 0000000..fe50697
--- /dev/null
+++ b/docs/gl_objects/namespaces.py
@@ -0,0 +1,7 @@
+# list
+namespaces = gl.namespaces.list()
+# end list
+
+# search
+namespaces = gl.namespaces.list(search='foo')
+# end search
diff --git a/docs/gl_objects/namespaces.rst b/docs/gl_objects/namespaces.rst
new file mode 100644
index 0000000..1819180
--- /dev/null
+++ b/docs/gl_objects/namespaces.rst
@@ -0,0 +1,21 @@
+##########
+Namespaces
+##########
+
+Use :class:`~gitlab.objects.Namespace` objects to manipulate namespaces. The
+:attr:`gitlab.Gitlab.namespaces` manager objects provides helper functions.
+
+Examples
+========
+
+List namespaces:
+
+.. literalinclude:: namespaces.py
+ :start-after: # list
+ :end-before: # end list
+
+Search namespaces:
+
+.. literalinclude:: namespaces.py
+ :start-after: # search
+ :end-before: # end search
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst
index 08c4bc7..32d6719 100644
--- a/docs/gl_objects/runners.rst
+++ b/docs/gl_objects/runners.rst
@@ -13,7 +13,7 @@ Examples
Use the ``list()`` and ``all()`` methods to list runners.
- The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
+The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
and ``online``.