Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
~~~~~~~~~~~
Expand Down
3 changes: 1 addition & 2 deletions sphinx_rtd_theme/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,10 @@

{% block extrabody %} {% endblock %}
<div class="wy-grid-for-nav">

{# SIDE NAV, TOGGLES ON MOBILE #}
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{% block sidebartitle %}

{% if logo and theme_logo_only %}
Expand Down
3 changes: 2 additions & 1 deletion sphinx_rtd_theme/theme.conf
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ collapse_navigation = True
sticky_navigation = True
navigation_depth = 4
includehidden = True
titles_only =
titles_only =
logo_only =
display_version = True
prev_next_buttons_location = bottom
style_external_links = False
style_nav_header_background =