summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-09 16:51:13 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-09 16:51:13 +0200
commitab7d794251bcdbafce69b1bde0628cd3b710d784 (patch)
tree9771cd98e7685b4d99f8d2ed08772199bd6531ee /docs/gl_objects
parent1c53ecbf8b6fcdb9335874734855ca7cab1999f6 (diff)
downloadgitlab-ab7d794251bcdbafce69b1bde0628cd3b710d784.tar.gz
docs: add ApplicationSettings API
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/settings.py8
-rw-r--r--docs/gl_objects/settings.rst22
2 files changed, 30 insertions, 0 deletions
diff --git a/docs/gl_objects/settings.py b/docs/gl_objects/settings.py
new file mode 100644
index 0000000..834d43d
--- /dev/null
+++ b/docs/gl_objects/settings.py
@@ -0,0 +1,8 @@
+# get
+settings = gl.settings.get()
+# end get
+
+# update
+s.signin_enabled = False
+s.save()
+# end update
diff --git a/docs/gl_objects/settings.rst b/docs/gl_objects/settings.rst
new file mode 100644
index 0000000..26f68c5
--- /dev/null
+++ b/docs/gl_objects/settings.rst
@@ -0,0 +1,22 @@
+########
+Settings
+########
+
+Use :class:`~gitlab.objects.ApplicationSettings` objects to manipulate Gitlab
+settings. The :attr:`gitlab.Gitlab.settings` manager object provides helper
+functions.
+
+Examples
+--------
+
+Get the settings:
+
+.. literalinclude:: settings.py
+ :start-after: # get
+ :end-before: # end get
+
+Update the settings:
+
+.. literalinclude:: settings.py
+ :start-after: # update
+ :end-before: # end update