Metadata-Version: 2.1
Name: sphinx-theme-builder
Version: 0.2.0a15
Summary: A tool for authoring Sphinx themes with a simple (opinionated) workflow.
Author-email: Pradyun Gedam <mail@pradyunsg.me>
License: The MIT License (MIT)
        
        Copyright (c) 2021 Pradyun Gedam
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Documentation, https://sphinx-theme-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/pradyunsg/sphinx-theme-builder
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-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: cli
License-File: LICENSE

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