Skip to content

Instructions for using the theme #32

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

Merged
Mariatta merged 2 commits into from
Sep 14, 2020
Merged

Instructions for using the theme #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c9d8c2e
Instructions for using the theme
tapaswenipathak Oct 15, 2019
7575afc
Merge branch 'master' into issue-16
Mariatta Sep 14, 2020
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
13 changes: 7 additions & 6 deletions README.rst
View file
Open in desktop
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