Developing themes for Sphinx

The basics

All Sphinx themes must have:

• A theme.conf file.

• A layout.html file.

• A distribution method.

Distributing themes

Understanding Sphinx's 'basic' theme

A great way to get a basic understanding of how themes work in Sphinx is to take a look at the 'basic' theme, which is the theme that most other Sphinx themes inherit.

Essential links

• Sphinx 'basic' theme source

• Jinja template designer documentation

• MDN web docs: HTML/Reference

• MDN web docs: CSS/Reference

• MDN web docs: JavaScript/Reference