sphinx-doc / sphinx-doc/sphinx
Doc: ".. sidebar::" rendered oddly in new theme
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
With the new theme that was just deployed for the Sphinx documentation, https://www.sphinx-doc.org/en/master/usage/quickstart.html looks like this:
"reStructuredText directives" shouldn't break the vertical spacing like that, it should be some additional content on the right in parallel with the main text but without disturbing it.
How to Reproduce
Visit https://www.sphinx-doc.org/en/master/usage/quickstart.html.
Expected behavior
No response
Your project
N/A
Screenshots
No response
OS
N/A
Python version
N/A
Sphinx version
N/A
Sphinx extensions
No response
Extra tools
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by opening the linked quickstart page and inspecting how the .. sidebar:: directive is rendered with the new documentation theme. Compare its spacing with the expected parallel right-side content; done means the sidebar no longer disrupts the main text's vertical flow.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100