docs: add licenses API

2 files changed, 29 insertions, 0 deletions

diff --git a/docs/gl_objects/licenses.py b/docs/gl_objects/licenses.py
new file mode 100644
index 0000000..425a9a4
--- /dev/null
+++ b/docs/gl_objects/licenses.py
@@ -0,0 +1,8 @@
+# list
+licenses = gl.licenses.list()
+# end list
+
+# get
+license = gl.licenses.get('apache-2.0', project='foobar', fullname='John Doe')
+print(license.content)
+# end get
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