Skip to content

Commit 07b2522

Browse files
committed
Default stickynav to on properly.
This is documented as being on, but previously we weren't running `tobool` on it to check it properly. This had the effect of always returning True unless the user set it to False in Python. You can see the commit that changed it here: https://github.com/rtfd/sphinx_rtd_theme/pull/496/files#diff-1336f80431f476a232e3c48abb277c51R210 This properly defaults it to True, so that navigation works :)
1 parent d756528 commit 07b2522

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,17 +87,17 @@ file of this repository, and can be defined in your project's ``conf.py`` via
8787
.. code:: python
8888
8989
html_theme_options = {
90-
'typekit_id': hiw1hhg,
91-
'canonical_url':
92-
'analytics_id':
93-
'collapse_navigation': False
94-
'sticky_navigation': False
95-
'navigation_depth': 4
96-
'includehidden': True
97-
'logo_only':
98-
'display_version': True
90+
'typekit_id': '',
91+
'canonical_url': '',
92+
'analytics_id': '',
93+
'collapse_navigation': False,
94+
'sticky_navigation': True,
95+
'navigation_depth': 4,
96+
'includehidden': True,
97+
'logo_only': False,
98+
'display_version': True,
9999
'prev_next_buttons_location': bottom,
100-
'style_external_links': False
100+
'style_external_links': False,
101101
}
102102
103103
The following options are available:

sphinx_rtd_theme/theme.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ typekit_id = hiw1hhg
88
canonical_url =
99
analytics_id =
1010
collapse_navigation = False
11-
sticky_navigation = False
11+
sticky_navigation = True
1212
navigation_depth = 4
1313
includehidden = True
1414
logo_only =

0 commit comments

Comments
 (0)