sphinx-doc / sphinx-doc/sphinx
Double blank in title of Windows HTML Help
Open
Nobody has claimed this yet.
type:question
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
When building Windows HTML Help and I defined no release information, it resulted in a double blank within the title definition of the Contents tree.
This behavior comes from joining the project and release information in the code line.
My question: Is this behavior correct or should we modify the code to avoid this?
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
Read sphinx/builders/html.py at the linked line and reproduce a Windows HTML Help build with no release information. Check the generated Contents title for the extra space, then establish the expected title behavior and verify the result against that expectation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100