From 0b5e1172cd9529274e695c4df156637a3972c8d9 Mon Sep 17 00:00:00 2001 From: Andreas Maier Date: Tue, 21 Jul 2020 11:50:39 +0200 Subject: [PATCH] Added info about updating the conf.py file to README file Details: * It turns out that projects other than Python 3 that use the theme have to set it up in their conf.py files. This change adds the instructions to set that up, to the README file. See issue #45. Signed-off-by: Andreas Maier --- README.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 476a46c0..6dabaed7 100644 --- a/README.rst +++ b/README.rst @@ -10,8 +10,8 @@ projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust. -To use the theme, install it into your docs build environment via ``pip`` -(preferably in a virtual environment). +To use the theme, install it into your docs build environment via ``pip`` +(preferably in a virtual environment) and update your ``conf.py`` file as shown. 1. Create and activate a virtual environment:: @@ -19,5 +19,17 @@ To use the theme, install it into your docs build environment via ``pip`` $ source env/bin/activate 2. Install python-docs-theme using `pip`:: - + (env)$ python -m pip install python-docs-theme + +3. In your ``conf.py`` file, add ``'python_docs_theme'`` to the loaded + extensions:: + + extensions = [ + ..., + 'python_docs_theme', + ] + + and set it as the scheme for HTML output:: + + html_theme = 'python_docs_theme'