guzzle_sphinx_theme icon indicating copy to clipboard operation
guzzle_sphinx_theme copied to clipboard

Table of contents sidebar broken in Sphinx 1.7

Open Terrance opened this issue 7 years ago • 4 comments

As of Sphinx 1.7, the styling of the sidebar is rather broken as some of the elements have moved around (e.g. sidebar-localtoc has been renamed to sidebar-toc). The mobile layout shows similar issues.

Basic config file and index page
import guzzle_sphinx_theme


templates_path = ["_templates"]
exclude_patterns = ["_build"]

master_doc = "index"

project = "Test"
author = "Author"
copyright = "2018, {}".format(author)

html_theme = "guzzle_sphinx_theme"
html_theme_path = guzzle_sphinx_theme.html_theme_path()

html_title = project
Index
=====

.. toctree::
    self
    page

Subheading 1
------------

Some text.

Subheading 2
------------

Some more text.
Output from 1.6.6

1.6.6

Output from 1.7.0

1.7.0

Terrance avatar Feb 19 '18 13:02 Terrance

Same issue here.

seisman avatar Mar 04 '18 08:03 seisman

Are there any known workarounds for this?

naftulikay avatar Jan 20 '19 22:01 naftulikay

This is a crucial issue, hope will fixed soon.

mapattacker avatar Oct 26 '19 16:10 mapattacker

It looks like the theme is getting tripped up by the new default sidebar list in Sphinx 1.7.0. It can be fixed on the theme side by supplying a list of sidebars in theme.conf.

And in the meantime, to work around it in your own documentation, add the following line to conf.py:

html_sidebars = {'**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']}

tmadden avatar Jun 01 '20 20:06 tmadden