Injecting code

Sphinx makes it fairly straightforward to add custom JS/CSS/HTML code to your pages. Furo supports the mechanisms provided by Sphinx for this.

CSS or JS

ReadTheDocs has an excellent explanation on how to add custom CSS or JS files to Sphinx-based documentation. No point repeating information in two places. 😄

HTML

小心

This customisation considered “unstable” under Furo’s stability policy.

This is entirely powered by Sphinx’s templating mechanism, which is built upon Jinja2.

The primary way to do this is to override the content of the Furo’s default templates with your own templates, using templates_path. For more information on how to do so, Sphinx’s templating documentation.

注解

The expectation is that users who override Furo’s templates would also carefully consider how their documentation looks across various platforms (i.e. not take a “looks OK on my machine” approach) and would also be willing to extend Furo’s CSS to make their HTML changes work well.