summaryrefslogtreecommitdiff
path: root/docs/gl_objects/licenses.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/licenses.rst')
-rw-r--r--docs/gl_objects/licenses.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/gl_objects/licenses.rst b/docs/gl_objects/licenses.rst
new file mode 100644
index 0000000..2b82379
--- /dev/null
+++ b/docs/gl_objects/licenses.rst
@@ -0,0 +1,21 @@
+########
+Licenses
+########
+
+Use :class:`~gitlab.objects.License` objects to manipulate licenses. The
+:attr:`gitlab.Gitlab.licenses` manager object provides helper functions.
+
+Examples
+--------
+
+List known licenses:
+
+.. literalinclude:: licenses.py
+ :start-after: # list
+ :end-before: # end list
+
+Generate a license content for a project:
+
+.. literalinclude:: licenses.py
+ :start-after: # get
+ :end-before: # end get