summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorJonathan Holloway <jholloway@redhat.com>2016-11-29 20:43:41 -0600
committerJonathan Holloway <jholloway@redhat.com>2016-12-04 19:17:59 -0800
commitb9559eccf8fd3c03b7866de79a3c5d57bcd50a21 (patch)
tree5fd10fdd8cf68f6cc4465fbe24f2a0c796069169 /docs/index.rst
parentf6c0b1b4bb5edf09af0065c831e9002a15375993 (diff)
docs: initial sphinx setup
Change-Id: Ibeac5bba6423cbf93577d8d11cc8f3540e900a5a Signed-off-by: Jonathan Holloway <jholloway@redhat.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..909d70b97
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,36 @@
+.. glusto-tests documentation master file, created by
+ sphinx-quickstart on Wed Jun 1 19:57:06 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to the Glusto-tests documentation!
+==========================================
+
+Glusto-tests is a repository for gluster-related test libraries using Glusto.
+
+User Guide
+----------
+
+.. toctree::
+ :maxdepth: 3
+
+ userguide/intro
+
+
+API
+===
+
+.. toctree::
+ :maxdepth: 2
+
+ source/glustolibs
+.. source/glustolibs.io
+
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+