IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Document option

Browse Source
This commit is contained in:
Jesse Tan 2017-12-05 10:33:58 +01:00
parent 6c2302472f
commit 35143f50e8
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@ -96,7 +96,8 @@ file of this repository, and can be defined in your project's ``conf.py`` via
'includehidden': True 'includehidden': True
'logo_only': 'logo_only':
'display_version': True 'display_version': True
'prev_next_buttons_location': bottom 'prev_next_buttons_location': bottom,
'style_external_links': False
} }
The following options are available: The following options are available:
@ -107,6 +108,7 @@ The following options are available:
* ``includehidden`` Specifies if the global toctree includes toctrees marked with the `:hidden:` option * ``includehidden`` Specifies if the global toctree includes toctrees marked with the `:hidden:` option
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None`` * ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly and will display the "Next" and "Previous" buttons accordingly
* ``style_external_links`` Add an icon next to external links. Defaults to ``False``.
Page-level configuration Page-level configuration
------------------------ ------------------------