summaryrefslogtreecommitdiff
path: root/docs/sphinx/index.rst
diff options
context:
space:
mode:
authordrebs <drebs@leap.se>2014-02-17 18:18:25 -0300
committerdrebs <drebs@leap.se>2014-02-17 18:23:17 -0300
commit3f08feb188643f6439b9f5f9dde9ddd891197a7d (patch)
tree1469c197c9f91523087bc9904d81444004ca1a76 /docs/sphinx/index.rst
parent7abab84bb37fc40feda49593d65a76459ee4eaf3 (diff)
Add sphinx doc.
Diffstat (limited to 'docs/sphinx/index.rst')
-rw-r--r--docs/sphinx/index.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
new file mode 100644
index 00000000..6298d034
--- /dev/null
+++ b/docs/sphinx/index.rst
@@ -0,0 +1,31 @@
+.. Soledad documentation master file, created by
+ sphinx-quickstart on Mon Feb 17 17:54:47 2014.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Soledad documentation
+=====================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ common
+ client
+ server
+
+.. automodule:: leap.soledad.common
+ :members:
+ :undoc-members:
+ :private-members:
+ :show-inheritance:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+