Skip to content

Commit

Permalink
Add instructions for using the theme (#32)
Browse files Browse the repository at this point in the history
Fixes #16.

Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
  • Loading branch information
tapaswenipathak and Mariatta committed Sep 14, 2020
1 parent c2115b3 commit 3f9bad7
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ trust.
To use the theme, install it into your docs build environment via ``pip``
(preferably in a virtual environment).

1. Create and activate a virtual environment::

$ python -m venv env
$ source env/bin/activate
Configuration options
---------------------

2. Install python-docs-theme using `pip`::
(env)$ python -m pip install python-docs-theme
To use this theme, add the following to ``conf.py``::

- ``html_theme = 'python_docs_theme'``

- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars

0 comments on commit 3f9bad7

Please sign in to comment.