Add branches API documentation

1 files changed, 41 insertions, 0 deletions

diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst
new file mode 100644
index 0000000..9ec6860
--- /dev/null
+++ b/docs/gl_objects/branches.rst
@@ -0,0 +1,41 @@
+########
+Branches
+########
+
+Use :class:`ProjectBranch` objects to manipulate repository branches.
+
+To create :class:`ProjectBranch` objects use the
+:class:`Gitlab.project_branches` or :class:`Project.branches` managers.
+
+Examples
+========
+
+Get the list of branches for a repository:
+
+.. literalinclude:: branches.py
+   :start-after: # list
+   :end-before: # end list
+
+Get a single repository branch:
+
+.. literalinclude:: branches.py
+   :start-after: # get
+   :end-before: # end get
+
+Create a repository branch:
+
+.. literalinclude:: branches.py
+   :start-after: # create
+   :end-before: # end create
+
+Delete a repository branch:
+
+.. literalinclude:: branches.py
+   :start-after: # delete
+   :end-before: # end delete
+
+Protect/unprotect a repository branch:
+
+.. literalinclude:: branches.py
+   :start-after: # protect
+   :end-before: # end protect