Skip to content

Fixes #45: Added info about updating the conf.py file to README file #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andy-maier wants to merge 1 commit into from
Closed

Fixes #45: Added info about updating the conf.py file to README file #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,26 @@ 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::

$ python -m venv env
$ 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'