summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Wittig <max.wittig95@gmail.com>2018-10-07 17:34:01 +0200
committerMax Wittig <max.wittig95@gmail.com>2018-10-07 17:34:01 +0200
commit6585c967732fe2a53c6ad6d4d2ab39aaa68258b0 (patch)
tree3edd707060e31bb7ef25cc03d6a741cc7d3906fe
parent5ff2608f3eef773f06d3b1c70c2317a96f53a4b4 (diff)
downloadgitlab-6585c967732fe2a53c6ad6d4d2ab39aaa68258b0.tar.gz
docs(readme): add docs build information
-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
============