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

Documentation

Browse Source
This commit is contained in:
Gergely Csatari 2019-01-04 08:39:21 +01:00
parent 16f8cdcf49
commit 17691e9213
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/configuring.rst
View File

@ -25,6 +25,7 @@ file of this repository, and can be defined in your project's ``conf.py`` via
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': '',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
@ -49,6 +50,9 @@ Base options
* ``vcs_pageview_mode`` String. Changes how to view files when using `display_github`, `display_gitlab`, etc.
When using Github or Gitlab this can be: `blob` (default), `edit`, or `raw`,
on Bitbucket, this can be either: `view` (default) or `edit`.
* ``style_nav_header_background`` String. Changes the background of the search area in the navigation bar. The value
can be anything valid in a CSS `background` property. The default `#2980B9` will be used if the property is not
defined.
TOC Options
~~~~~~~~~~~