search

guzzle / guzzle_sphinx_theme

Sphinx theme used by Guzzle
MIT License
169 stars 60 forks source link

Table of contents sidebar broken in Sphinx 1.7 #33

Open Terrance opened 6 years ago

Terrance commented 6 years ago

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 ```python 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 ``` ```rst Index ===== .. toctree:: self page Subheading 1 ------------ Some text. Subheading 2 ------------ Some more text. ```
Output from 1.6.6 ![1.6.6](https://user-images.githubusercontent.com/4025899/36370474-dbb8f4a8-1556-11e8-88ff-d71bf4975642.png)
Output from 1.7.0 ![1.7.0](https://user-images.githubusercontent.com/4025899/36370497-e98d2432-1556-11e8-9eda-c6f2082748f9.png)
seisman commented 6 years ago

Same issue here.

naftulikay commented 5 years ago

Are there any known workarounds for this?

mapattacker commented 4 years ago

This is a crucial issue, hope will fixed soon.

tmadden commented 4 years ago

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