Skip to content

Commit 3f9bad7

Browse files
Add instructions for using the theme (#32)
Fixes #16. Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>
1 parent c2115b3 commit 3f9bad7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ trust.
1313
To use the theme, install it into your docs build environment via ``pip``
1414
(preferably in a virtual environment).
1515

16-
1. Create and activate a virtual environment::
1716

18-
$ python -m venv env
19-
$ source env/bin/activate
17+
Configuration options
18+
---------------------
2019

21-
2. Install python-docs-theme using `pip`::
22-
23-
(env)$ python -m pip install python-docs-theme
20+
To use this theme, add the following to ``conf.py``::
21+
22+
- ``html_theme = 'python_docs_theme'``
23+
24+
- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy