sphinx-doc / sphinx-doc/sphinx

Improve favicon support by incorporating `sphinx-favicon` in `sphix.ext`

Open
#9,861 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:enhancement
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.
Lots of things have changed since the last time adding a icon to the documentation was simply achieved by having a favicon.ico file.

The folks from evil martians did a very nice research on the topic and realised that, if we ignore old browsers/versions of browsers, 6 icon files cover most of the cases.

However, with Sphinx we can only specify one (without setting any attribute like the content-type).

Describe the solution you'd like
@tcmetzger did an amazing work by creating sphinx-favicon which can be used in this scenario.

Recently, there was a discussion in the setuptools repository, where it was mentioned that maybe it would be nice to have this extension directly under the sphinx package.

The intention of this issue is to start a discussion with sphinx and sphinx-favicon maintainers see if both sides have interest on making sphinx-favicon part of the sphinx repository (alongside the other sphinx.ext packages).

Describe alternatives you've considered
One alternative is keeping sphinx-favicon as it is currently is, a separated package, which is not bad. But some people consider this use-case so common that it would be nice to have it supported out of the box.

The other alternative is for sphinx to support the use case directly, without the need of extensions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing sphinx.ext packages and the linked sphinx-favicon project, then read the discussion referenced in the issue. Determine whether maintainers want to adopt the extension or support multiple favicon files directly; done requires an agreed scope and implementation plan, since no target files or tests are identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.