Skip to content

Commit ab7d794

Browse files
author
Gauvain Pocentek
committed
docs: add ApplicationSettings API
1 parent 1c53ecb commit ab7d794

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

docs/api-objects.rst

+1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ API objects manipulation
1919
gl_objects/milestones
2020
gl_objects/projects
2121
gl_objects/runners
22+
gl_objects/settings
2223
gl_objects/users

docs/gl_objects/settings.py

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# get
2+
settings = gl.settings.get()
3+
# end get
4+
5+
# update
6+
s.signin_enabled = False
7+
s.save()
8+
# end update

docs/gl_objects/settings.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
########
2+
Settings
3+
########
4+
5+
Use :class:`~gitlab.objects.ApplicationSettings` objects to manipulate Gitlab
6+
settings. The :attr:`gitlab.Gitlab.settings` manager object provides helper
7+
functions.
8+
9+
Examples
10+
--------
11+
12+
Get the settings:
13+
14+
.. literalinclude:: settings.py
15+
:start-after: # get
16+
:end-before: # end get
17+
18+
Update the settings:
19+
20+
.. literalinclude:: settings.py
21+
:start-after: # update
22+
:end-before: # end update

0 commit comments

Comments
 (0)