summaryrefslogtreecommitdiff
path: root/docs/gl_objects/namespaces.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-04 08:27:18 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-04 08:27:18 +0200
commit1f52cd2df35dab33dbf7429c8d514443278b549a (patch)
treed98ccb4db7b892648b08d01d385be8e82d971173 /docs/gl_objects/namespaces.rst
parente0f2290fdbbb8d2ee4c9fcb9e531b04bb69232fa (diff)
downloadgitlab-1f52cd2df35dab33dbf7429c8d514443278b549a.tar.gz
document namespaces API
Diffstat (limited to 'docs/gl_objects/namespaces.rst')
-rw-r--r--docs/gl_objects/namespaces.rst21
1 files changed, 21 insertions, 0 deletions
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