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

[trsvchn]

🐛 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:




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

[vfdev-5]

@trsvchn thanks for the report, yes, I noticed that too but I thought that it was due to newly introduced type annotations.

After roll back to old version everything works fine

Does it mean, you have you tested current master branch with sphinx==1.8.5 ?

If yes, maybe we can try the latest version of sphinx == 3.2.1 and check if it was fixed ?

[trsvchn]

@vfdev-5 Yes, I've tested it with 3 versions: 1.8.5 2.4.4 and 3.1 (bad one)
Sure, I am going to try sphinx == 3.2.1

[trsvchn]

Nope all new versions after 2.4.4 do not produce the right results, same problem. I've also find this Pin Sphinx to 2.4.4 , they also pinned to 2.4.4 version, looks like pytorch theme has some troubles with newer sphinx.

[vfdev-5]

@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

[trsvchn]

@vfdev-5 I agree with you, we need to downgrade, since for "autotoc" there is alternative solution from SO + we can do it manually (as always :) But I didn't find any solution for that weird header layout.

[trsvchn]

With #1374 (from netlify preview):

[vfdev-5]

@trsvchn awesome, thanks a lot !