From c9d8c2eff6ad501d467a856cffcaeabf13f23593 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Tue, 15 Oct 2019 05:47:44 +0530 Subject: [PATCH] Instructions for using the theme Fixes https://github.com/python/python-docs-theme/issues/16. --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 1ba7962..3c3d3d4 100644 --- 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