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

Significant visual regression in collapse headings mode with Sphinx 4 #46

Open
Tracked by #49
CAM-Gerlach opened this issue Jan 30, 2022 · 0 comments
Open
Tracked by #49
Assignees
Labels
Milestone

Comments

@CAM-Gerlach
Copy link
Member

I've noticed this a while ago, but didn't want to hold up the v0.2.0 release with it.

There's a significant visual regression with docstring display using Sphinx 4 (repro'd in 4.0.3 and 4.4.0; renders correctly in 3.5.3). The headings don't display as they did before, and collapse mode no longer works.

I tested all the way back to the earliest working commits using the fabfile.py collapse test and the difference between Sphinx 3 and Sphinx 4 was still present, in otherwise identical environments. From skimming the DOM, it looks like either the script that does it isn't firing at all, or it isn't finding the correct elements to modify.

@martinRenou , any change you or one of your colleagues could help fix this?

Running the numpy.sin test works as before.

python -I -bb -X dev -m pytest --open-browser -k numpy_module --asyncio-mode=auto -W default

gives:

Sphinx 3, numpy module test:

image

Sphinx 4, numpy module test:

image

Running the numpy.sin test works as before

python -I -bb -X dev -W error -m pytest --open-browser -k sin --asyncio-mode=auto

gives:

Sphinx 3, numpy.sin test:

image

Sphinx 4, numpy.sin test:

image

Running the collapse test, however, shows very different results.

python -I -bb -X dev -W error -m pytest --open-browser -k collapse --asyncio-mode=auto

gives:

Sphinx 3, collapse test:

image

Sphinx 4, collapse test:

image

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

No branches or pull requests

2 participants