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

Broken rendering of 'usage' page on readthedocs #280

Closed
EFord36 opened this issue Feb 9, 2024 · 3 comments · Fixed by #281
Closed

Broken rendering of 'usage' page on readthedocs #280

EFord36 opened this issue Feb 9, 2024 · 3 comments · Fixed by #281
Labels
Accepted Accepted issue on our roadmap Bug A bug

Comments

@EFord36
Copy link
Contributor

EFord36 commented Feb 9, 2024

Hi,

I was reading the docs at https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html

and noticed the page "Tooltip with content that needs extra rendering steps" onwards rendering strangely:

image

that screenshot was for Chrome on an M2 Mac, it also affects safari in the same way:

Screenshot 2024-02-09 at 11 33 41

This seems unintentional to me, so thought I would open an issue.

I had a quick look but didn't see an obvious problem - is it perhaps the use of the .. bibliography:: directive in the previous section causing the issue, perhaps sphinxcontrib-bibtex expects the bibliography to always be at the end of a page? I had a quick look at that code and couldn't see a smoking gun either, but I could just not know what I'm looking at.

@humitos humitos added Bug A bug Accepted Accepted issue on our roadmap labels Feb 9, 2024
@humitos
Copy link
Member

humitos commented Feb 12, 2024

Thanks for reporting this. Would you like to take a look at this and propose a PR to fix it? 😄

@EFord36
Copy link
Contributor Author

EFord36 commented Feb 12, 2024

Sure, I can give it a go!

@EFord36
Copy link
Contributor Author

EFord36 commented Feb 12, 2024

I've just looked at this, and actually, installing fresh and building, there's no problems. I diff-ed the live docs with my built version, and saw that the live docs were built with docutils 0.18.0. Downgrading to that version and building locally causes the error, so it looks like it's the docutils version (combined with other versions of packages presumably) that's the problem. I opened #281 to add a minimum version of docutils, but presumably anything that triggers a rebuild of the live readthedocs docs would fix the current problem (assuming it ends up with a fresh enough python environment).

humitos pushed a commit that referenced this issue Feb 23, 2024
Dependencies: add sphinxcontrib-bibtex min version

Otherwise the lack of a pin on docutils causes bad html rendering.

Docutils versions lower than 0.20 cause rendering problems in the usage page with
the bibliography, see #280.

upgrade docs/requirements.txt with pip-compile after the pyproject.toml
change.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants