sphinx-doc / sphinx-doc/sphinx
Sphinx-generated documentation is missing license text for bundled JS and CSS
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
Packaging Sphinx-generated documentation in a way that complies with the Fedora packaging guidelines is very difficult. The main problem appears to be that the generated docs do not include license information, which makes them unredistributable.
How to Reproduce
Try to package Sphinx-generated docs in compliance with Fedora packaging guidelines
Expected behavior
Generated docs include license text wherever that is required.
Your project
N/A
Screenshots
N/A
OS
N/A
Python version
N/A
Sphinx version
Latest packaged in Fedora I believe
Sphinx extensions
N/A
Extra tools
N/A
Additional context
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 reproducing the Fedora packaging case for Sphinx-generated documentation and inspect the bundled JavaScript and CSS assets for missing license information. Review the linked Fedora Bugzilla report for the packaging requirements. Done means generated documentation includes the required license text wherever bundled assets require it.
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
- Needs clarification
- Newbie friendliness
- 25/100