Commit3f9bad7

and

authored

Add instructions for using the theme (#32)

Fixes#16.Co-authored-by: Mariatta <Mariatta@users.noreply.github.com>

1 parentc2115b3 commit3f9bad7Copy full SHA for 3f9bad7

File tree

-6

lines changed

-6

lines changed

Lines changed: 7 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,12 @@ trust.`
`13`	`13`	To use the theme, install it into your docs build environment via ``pip``
`14`	`14`	`(preferably in a virtual environment).`
`15`	`15`
`16`		`-1. Create and activate a virtual environment::`
`17`	`16`
`18`		`- $ python -m venv env`
`19`		`- $ source env/bin/activate`
	`17`	`+Configuration options`
	`18`	`+---------------------`
`20`	`19`
`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

Comments

(0)