[doc] add sphinx doc boilerplate

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..f043c05
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,44 @@
+.. memoryhole documentation master file, created by
+   sphinx-quickstart on Thu Jul  7 14:53:06 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+memoryhole
+======================================
+
+memoryhole is a library that sends email metadata down the memory hole.
+
+Quickstart guide
+-----------------
+
+To protect a message::
+
+  protect(msg)
+
+To unprotect::
+
+  unwrap(msg)
+
+Options
+--------
+
+You can pass some options to the public api::
+
+  opts = Options(blah)
+
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+