From ab7d794251bcdbafce69b1bde0628cd3b710d784 Mon Sep 17 00:00:00 2001 From: Gauvain Pocentek Date: Tue, 9 Aug 2016 16:51:13 +0200 Subject: docs: add ApplicationSettings API --- docs/gl_objects/settings.py | 8 ++++++++ docs/gl_objects/settings.rst | 22 ++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/gl_objects/settings.py create mode 100644 docs/gl_objects/settings.rst (limited to 'docs/gl_objects') 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 -- cgit v1.2.1