summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/index.rst1
-rw-r--r--docs/install.rst21
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index ee9980e..8ddf933 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 2
+ install
cli
usage
api/gitlab
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..6abba3f
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,21 @@
+############
+Installation
+############
+
+``python-gitlab`` is compatible with python 2 and 3.
+
+Use :command:`pip` to install the latest stable version of ``python-gitlab``:
+
+.. code-block:: console
+
+ $ pip install --upgrade python-gitlab
+
+The current development version is available on `github
+<https://github.com/gpocentek/python-gitlab>`__. Use :command:`git` and
+:command:`pip` to install it:
+
+.. code-block:: console
+
+ $ git clone https://github.com/gpocentek/python-gitlab
+ $ cd python-gitlab
+ $ python setup.py install