Skip to content

Commit

Permalink
Document how to configure via html_theme_options
Browse files Browse the repository at this point in the history
  • Loading branch information
akien-mga committed Jul 20, 2016
1 parent f2cfc5b commit edb9da7
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.rst
Expand Up @@ -66,6 +66,21 @@ Configuration

You can configure different parts of the theme.

Project-wide configuration
--------------------------

The theme's project-wide options are defined in the ``sphinx_rtd_theme/theme.conf``
file of this repository, and can be defined in your project's ``conf.py`` via
``html_theme_options``. For example:

.. code:: python
html_theme_options = {
'collapse_navigation': False,
'display_version': False,
'navigation_depth': 3,
}
Page-level configuration
------------------------

Expand Down

0 comments on commit edb9da7

Please sign in to comment.