# Sphinx Theme Builder

<!-- start-elevator-pitch -->

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

<!-- end-elevator-pitch -->

## Installation

<!-- start-installation -->

This project is available on
[PyPI](https://pypi.org/project/sphinx-theme-builder/), and can be installed
using `pip`:

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

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

<!-- end-installation -->

## 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.

[documentation]: https://sphinx-theme-builder.rtfd.io/
[development documentation]:
  https://sphinx-theme-builder.rtfd.io/en/latest/development/
