Change the favicon of the Sphinx Read The Docs theme?

Question

I'm already using a custom css to override some of the styles of the theme using

def setup(app):
    app.add_css_file('custom.css')

This works fine. What other app. functions are available? I can't find any documentation.

I'm looking for the function to override the favicon.

It's in your theme's template. You can override theme files. — Steve Piercy, Feb 11 '19 at 22:06
Thanks @StevePiercy for your reply. Can you show me how I can override theme files? Or do I need to download the full theme and make a custom version? I would like to avoid that. — Paul Meems, Feb 12 '19 at 08:51
It depends on the theme. For both included and installable themes, [SO has many posts](https://stackoverflow.com/search?q=%5Bpython-sphinx%5D+custom+theme) or consult [Sphinx docs](https://www.sphinx-doc.org/en/master/theming.html). — Steve Piercy, Feb 12 '19 at 09:03

score 36 · Answer 1 · edited Jan 28 '21 at 14:47

36

conf.py

html_favicon = 'favicon.ico'

I put favicon.ico in my source folder, next to my .rst-files and it is working as expected: https://global-coffee-data-standard.readthedocs.io/en/latest/index.html

edited Jan 28 '21 at 14:47

Kermit

answered Feb 13 '19 at 08:24

Paul Meems

1

Edited to `.ico` file extension. it failed with png – Kermit Jan 28 '21 at 14:48
For me, a file called `favicon.png` worked perfectly fine. Not sure why it didn't work for you. – mozzbozz Mar 11 '21 at 14:39
In the root folder of the project? Or the docs/ folder? – endolith Mar 20 '23 at 16:57
This doesn't work for me on github.io but works locally :/ – endolith Mar 25 '23 at 06:43

score 1 · Answer 2 · answered Oct 08 '21 at 18:13

In addition to Sphinx's native favicon support (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon), you can also use this Sphinx extension I created: https://pypi.org/project/sphinx-favicon/ With this extension, you can add multiple favicons, including apple-touch-icon and icons of different sizes. You can also use PNG or other supported file types.

2 Answers2