Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table of contents sidebar broken in Sphinx 1.7 #33

Open
Terrance opened this issue Feb 19, 2018 · 4 comments
Open

Table of contents sidebar broken in Sphinx 1.7 #33

Terrance opened this issue Feb 19, 2018 · 4 comments

Comments

@Terrance
Copy link

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

@seisman
Copy link

seisman commented Mar 4, 2018

Same issue here.

@naftulikay
Copy link

Are there any known workarounds for this?

@mapattacker
Copy link

This is a crucial issue, hope will fixed soon.

@tmadden
Copy link

tmadden commented Jun 1, 2020

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']}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants