Metadata-Version: 2.1
Name: sphinx-theme-builder
Version: 0.2.0b2
Summary: A tool for authoring Sphinx themes with a simple (opinionated) workflow.
Author-email: Pradyun Gedam <mail@pradyunsg.me>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Sphinx
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: pyproject-metadata
Requires-Dist: packaging
Requires-Dist: rich
Requires-Dist: nodeenv
Requires-Dist: setuptools
Requires-Dist: tomli ; python_version < '3.11'
Requires-Dist: typing_extensions ; python_version <= '3.7'
Requires-Dist: build ; extra == "cli"
Requires-Dist: click ; extra == "cli"
Requires-Dist: sphinx-autobuild ; extra == "cli"
Project-URL: Documentation, https://sphinx-theme-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/pradyunsg/sphinx-theme-builder
Provides-Extra: cli

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

<!-- 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/

