Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Change the favicon of the Sphinx Read The Docs theme?

Tags:

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.

like image 656
Paul Meems Avatar asked Feb 11 '19 21:02

Paul Meems


People also ask

What is Intersphinx?

ext. intersphinx – Link to other projects' documentation. New in version 0.5. This extension can generate links to the documentation of objects in external projects, either explicitly through the external role, or as a fallback resolution for any other cross-reference.

What size should a favicon be?

Favicon images are small in size, only 16 pixels in height by 16 pixels in width, so there is not much space for complex designs. Still, a good favicon that is clean, simple and easily identifiable can provide a good visual indicator for visitors navigating to your site through their tabs or bookmarks.


1 Answers

Thanks to @StevePiercy I found this documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon

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

like image 158
Paul Meems Avatar answered Sep 17 '22 16:09

Paul Meems