Uploaded image for project: 'docs'
  1. docs
  2. DOCS-117

sphinx-bootstrap default navbar_fixed_top breaks side navbar scrolling

    XMLWordPrintable

Details

    • Bug
    • Status: Resolved
    • High
    • Resolution: Cannot Reproduce
    • None
    • None
    • None
    • None

    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

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            chdbaugher David Baugher
            jmc-netactuate Joshua McBeth
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: