Instructions for using the theme

Fixes python#16.
tapaswenipathak · Oct 15, 2019 · c9d8c2e · c9d8c2e
1 parent b862f11
commit c9d8c2e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -13,3 +13,11 @@ trust.
 To use the theme, install it into your docs build environment via ``pip``::
 
     pip install python-docs-theme
+
+Configuring the options the conf.py holds
+------------------------------------------
+
+For implementing the theme you should
+- enable `html_theme = 'python_docs_theme'`
+- html_sidebars:
+  - Defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars