Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[DOCS] Rendered class and method signature overlaps with [source] after sphinx update

See original GitHub issue

🐛 Bug description

I’ve noticed that after updating to sphinx=3.1, documentation has some problem with class header layout, if you go to the docs webpage, you can find that in some cases type hits overlap with [SOURCE] button, in some cases even definition overlaps as well. Zooming-in/out doesn’t help.

Here is what I get: docs1 docs2 doc3

After roll back to old version everything works fine, Also, I’ve noticed in pytorch repo that they’re using sphinx==2.4.4, I’ve tried that version and it works well too.

Environment

sphinx==3.1

Issue Analytics

State:
Created 3 years ago
Comments:7

Top GitHub Comments

1reaction

trsvchncommented, Oct 7, 2020

With #1374 (from netlify preview): doc1 doc2

1reaction

vfdev-5commented, Oct 6, 2020

@trsvchn thanks for details, seems like we have no choice here. However, we wanted to update to 3.1 due to https://github.com/pytorch/ignite/issues/1273 . I think we have to downgrade to 2.4.4 and try to autogenerate toc tree somehow differently. If you guys have other ideas, we are open for that 😃

cc @theodumont for visibility

Top Results From Across the Web

Sphinx Documentation - Read the Docs

Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats,.

Plotly plots rendered by nbsphinx not showing in ... - GitHub

Plotly plots rendered by nbsphinx show (both locally and remotely) when using Alabaster just fine, but they don't show at all when using...

more_autodoc.overloads — sphinx-toolbox 3.2.0 documentation

The location to display overloads at: 'signature' – Display overloads above the function signature. 'top' – Display overloads at the top of the...

Gst-nvinfer — DeepStream 6.1.1 Release documentation

Property Meaning Network Types. / Applic... num‑detected‑classes Number of classes detected by the network Detector. Both tensor‑meta‑pool‑size Size of the output tensor meta pool All....

Release Notes — Airflow Documentation

However, since Airflow 2.0 DAG Serialization is a hard requirement and the Webserver used the serialized DAGs, there is no need to kill...