Document how to configure via html_theme_options

This commit is contained in:
Rémi Verschelde 2016-07-20 23:01:54 +02:00
parent f2cfc5b838
commit edb9da7bd3

View File

@ -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
------------------------