DOC: Update docs

2 files changed, 26 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 3bd6ee1..032547d 100644
--- a/README.rst
+++ b/README.rst
@@ -2,3 +2,28 @@ scipy-sphinx-theme
 ==================
 
 `Sphinx <http://sphinx-doc.org>`__ theme for `Scipy <http://scipy.org>`__.
+
+
+Theme options
+-------------
+
+The theme takes the followin options in the `html_options`
+configuration variable:
+
+.. attribute:: edit_link
+
+   Either ``true`` or ``false``. Determines if an "edit this page"
+   link is displayed in the left sidebar.
+
+.. attribute:: rootlinks
+
+   List of tuples ``(url, link_name)`` to show in the beginning of the
+   breadcrumb list on the top left. You can override it by defining
+   an `edit_link` block in ``searchbox.html``.
+
+The following blocks are defined:
+
+.. attribute:: searchbox.html:edit_link
+
+   Edit link HTML code to paste in the left sidebar, if `edit_link` is
+   enabled.
diff --git a/index.rst b/index.rst
index ee5827c..f7f8a75 100644
--- a/index.rst
+++ b/index.rst
@@ -14,6 +14,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   README
    test_optimize
    test_autodoc
    test_autodoc_2