summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvainpocentek@gmail.com>2018-10-11 18:51:55 +0200
committerGitHub <noreply@github.com>2018-10-11 18:51:55 +0200
commit156a21e1a2c9dcb6a14d95655ef24d5520e1dcc1 (patch)
treee40c2e50b41ac2b0952fca3223d8ee262608e205 /README.rst
parent5ff2608f3eef773f06d3b1c70c2317a96f53a4b4 (diff)
parentd29a48981b521bf31d6f0304b88f39a63185328a (diff)
downloadgitlab-156a21e1a2c9dcb6a14d95655ef24d5520e1dcc1.tar.gz
Merge pull request #608 from python-gitlab/ci-output-option
docs(cli): add PyYAML requirement notice
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index ff71fcb..e8f2d76 100644
--- a/README.rst
+++ b/README.rst
@@ -54,6 +54,13 @@ Documentation
The full documentation for CLI and API is available on `readthedocs
<http://python-gitlab.readthedocs.org/en/stable/>`_.
+Build the docs
+--------------
+You can build the documentation using ``sphinx``::
+
+ pip install sphinx
+ python setup.py build_sphinx
+
Contributing
============