-
Notifications
You must be signed in to change notification settings - Fork 52
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
IRRd documentation format fails presentation with many browsers #888
Comments
I don't know if this is a problem with the stuff in irrd/docs, or something at readthedocs.io. But I send people to the documentation every couple of weeks and it is very frustrating not to be able to render the items near the bottom of the left column. I can "control + '-'" a bunch of times, but that seems like the wrong solution. If the problem is with readthedocs.io, then we need to get a ticket filed with them. Not being familiar with how readthedocs works, or IRRd's use of it, I don't think I should be the one to file a bug report at https://github.com/readthedocs/readthedocs.org/issues |
It's a problem with the sphinx theme used to render the doc: https://github.com/irrdnet/irrd/blob/main/docs/conf.py#L92 I had noticed it being a bit funky, didn't know it was this annoying in some browsers. |
This fixes this with a hack - overriding the template's base.html to remove the md-sidebar class. Also updates the dependency
This fixes this with a hack - overriding the template's base.html to remove the md-sidebar class. Also updates the dependency
This fixes this with a hack - overriding the template's base.html to remove the md-sidebar class. Also updates the dependency (cherry picked from commit 06b5b8e) # Conflicts: # poetry.lock
Describe the bug
Chrome, Edge, Safari and maybe other browsers have difficulty correctly rendering: https://irrd.readthedocs.io/en/stable/
To Reproduce
Visit: https://irrd.readthedocs.io/en/stable/ and scroll to the bottom of the left column and try to click on "License". Many browsers will not let you scroll to the bottom. Firefox lets you, but only after rendering engine scrolls the document footer to the top of the screen.
Expected behaviour
Better rendering
IRRd version you are running
It does not matter, this is a documentation issue, not an IRRd V4 issue.
Additional context
The text was updated successfully, but these errors were encountered: