Sphinx Theme Builder

Streamline the Sphinx theme development workflow, by building upon existing standardised tools.

• simplified packaging experience
• simplified JavaScript tooling setup
• development server, with rebuild-on-save and automagical browser reloading
• consistent repository structure across themes

Installation

This project is available on PyPI, and can be installed using pip:

pip install "sphinx-theme-builder[cli]"

This project requires modern versions of CPython (>= 3.10).

Usage

Find more details on how to use this project in the documentation.

Contributing

stb is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at the Development Documentation for more information.