summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorMika Mäenpää <mika.j.maenpaa@tut.fi>2014-12-08 15:18:00 +0200
committerMika Mäenpää <mika.j.maenpaa@tut.fi>2014-12-09 11:50:04 +0200
commite822b0b06ba3ac615f465b9a66262aa799ebe1d4 (patch)
treed183ac0afea743cfd59f335014ff20cd25d2155d /docs/index.rst
parentd0884b60904ed22a914721a71f9bf2aaecab45b7 (diff)
downloadgitlab-e822b0b06ba3ac615f465b9a66262aa799ebe1d4.tar.gz
Simple sphinx-project that automatically creates api documentation.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..601e07f
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,24 @@
+.. python-gitlab documentation master file, created by
+ sphinx-quickstart on Mon Dec 8 15:17:39 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to python-gitlab's documentation!
+=========================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ usage
+ cli
+ api/gitlab
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`