From fafcc59680b6031bc4a0941123bf63291aca90d4 Mon Sep 17 00:00:00 2001
From: Stuart George <stuart.bigmassa@gmail.com>
Date: Mon, 5 Feb 2018 23:05:57 +0000
Subject: [PATCH] update docs

---
 docs/index.rst | 40 +++++++++++++++++++++++++++++++---------
 1 file changed, 31 insertions(+), 9 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index e30035f..87c6dfd 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,15 +6,37 @@
 Welcome
 =======
 
-Lorem ipsum dolor sit amet, tale vide mel te. Ei qui stet nostrud democritum.
-Ne quo viris appareat prodesset, mea ex nisl offendit, te his duis fierent recusabo.
-Malis iudicabit scripserit ne mei, an nonumes euripidis nec, ne pri dicit iisque suavitate.
-No mel detracto adipiscing scribentur.
-
-Agam deseruisse sed ut, ne vis option impetus. No vim mucius molestie insolens,
-eu mei sumo inermis. At nec facer maiestatis philosophia, audire assueverit persequeris
-mea ei, laudem veritus in sit. Eam ex ridens sanctus conceptam, in dictas laoreet
-pertinacia mei, et his quas timeam accusam.
+A simple responsive theme for sphinx. This theme is in it's early stage of development so only 
+contains limited options.
+
+Installing
+----------
+
+.. code-block:: bash
+
+    pip install karma_sphinx_theme
+
+Configuration
+-------------
+
+The theme's project-wide options are defined in the ``karma_sphinx_theme/theme.conf``
+file, and can be defined in your project's ``conf.py`` via
+``html_theme_options``. For example:
+
+.. code:: python
+
+    html_theme_options = {
+        'navigation_depth': 2,
+        'includehidden': True,
+        'titles_only': False
+    }
+
+Options
+-------
+
+* ``navigation_depth`` Int. Indicate the max depth of the tree, by default, 2 levels are included.
+* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
+* ``titles_only`` Bool. If True, removes headers within a page from the sidebar.
 
 .. toctree::
    :maxdepth: 1