[DOCS-117] sphinx-bootstrap default navbar_fixed_top breaks side navbar scrolling Created: 21/Mar/19 Updated: 13/Sep/19 Resolved: 13/Aug/19 |
|
| Status: | Resolved |
| Project: | docs |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | High |
| Reporter: | Joshua McBeth | Assignee: | David Baugher |
| Resolution: | Cannot Reproduce | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
Per https://pypi.org/project/sphinx-bootstrap-theme/0.4.8/ sphinx-bootstrap assumes a default of 'navbar_fixed_top': "true" if it is not set in html_theme_options of conf.py
I have confirmed that conf.py of the current github mirror of the docs project contains no html_theme_options and would inherit all defaults described at the URL given
This causes the sidebar to hover and it can not be scrolled until the content pane of the page is scrolled completely to the bottom.
For many documentation URLs this results in navigation requiring one to scroll through dozens of pages of content then multiple pages of navbar for the desired section to be visible to click and is almost but not quite entirely unusable in this form.
See e.g. https://docs.opendaylight.org/projects/aaa/en/stable-fluorine/dev-guide.html
The behavior is browser independent
Please set navbar_fixed_top to false in html_theme_options of conf.py |
| Comments |
| Comment by David Baugher [ 13/Aug/19 ] |
|
I cannot find the "navbar_fixed_top" parameter in the conf.py file. |
| Comment by Joshua McBeth [ 13/Sep/19 ] |
|
David,
Thank you for looking into this. The issue, as you've observed, is that the html_theme_options are not present. This results in the use of the default parameter, which recently changed in the theme to select the undesired navigation behavior described.
The html_theme_options dict needs to be added to conf.py if not present, and the key navbar_fixed_top needs to be added to the html_theme_options dict with the value false to disable this behavior. |