sphinx-doc / sphinx-doc/sphinx
Sphinx Sidebar Showing Different Items for Different Pages
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
If a document has no other reference links, the sidebar only shows it and the documents alphabetically before it in the sidebar for that section.
To Reproduce
Steps to reproduce the behavior:
$ make html
$ open build/html/index.html
Expected behavior
The sidebar to show correctly.
Your project
Screenshots
Wrong:
Right:
Environment info
- OS: MacOS Big Sur (11.2)
- Python version: 3.8
- Sphinx version: 3.5.4
- Sphinx extensions: None
- Extra tools: None
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 running make html and opening build/html/index.html, then compare the sidebar on the linked pages showing the wrong and right behavior. Trace how Sphinx builds the sidebar for those documents and identify why pages with no other reference links show only a partial section. Done means the generated sidebar is consistent across the affected pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100