summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGuillaume Horel <guillaume.horel@serenitascapital.com>2016-07-26 16:57:49 -0400
committerGuillaume Horel <guillaume.horel@serenitascapital.com>2016-07-26 16:57:49 -0400
commit7dc5473d4d6790c2b1fb513443df6383ba0af1f7 (patch)
treea07d7ec4ee10d70d1d1e77ec2e37acae11815217 /docs/index.rst
parent8b9ff1aff7dfc5771b47e90c25d3cfa19a45c94b (diff)
downloadpyisda-7dc5473d4d6790c2b1fb513443df6383ba0af1f7.tar.gz
start documenting the library
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..cc65826
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+.. PyISDA documentation master file, created by
+ sphinx-quickstart on Tue Jul 26 16:18:19 2016.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to PyISDA's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+