sphinx-doc / sphinx-doc/sphinx
Feature request: Adding html_touch_icon setting.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
When I create a document with Sphinx, I want to refer it from iOS or Android. But when I bookmark the doc link, it is not beautiful because it does not have an icon for it.
Describe the solution you'd like
Sphinx already has "html_fabicon" setting. Using the similar way, it would be great to add a "html_touch_icon" or something like that for setting apple touch icon tag in setup.py.
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 locating Sphinx's existing html_fabicon setting and the HTML output path, then review setup.py as referenced in the issue. Done means a new html_touch_icon setting can configure the Apple touch icon tag in generated documentation; verify the setting's behavior against the existing favicon handling.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100