diff --git a/README.rst b/README.rst index e7ad0f39a..005f3b97b 100644 --- a/README.rst +++ b/README.rst @@ -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 ------------------------