https://github.com/pradyunsg/sphinx-theme-builder
Streamline the Sphinx theme development workflow (maintained, but extremely stable as of Jan 2023)
https://github.com/pradyunsg/sphinx-theme-builder
Last synced: 5 months ago
JSON representation
Streamline the Sphinx theme development workflow (maintained, but extremely stable as of Jan 2023)
- Host: GitHub
- URL: https://github.com/pradyunsg/sphinx-theme-builder
- Owner: pradyunsg
- License: mit
- Created: 2021-11-02T07:36:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T13:31:38.000Z (over 1 year ago)
- Last Synced: 2024-03-23T12:31:21.719Z (about 1 year ago)
- Language: Python
- Homepage: https://sphinx-theme-builder.rtfd.io/
- Size: 293 KB
- Stars: 24
- Watchers: 3
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](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).
## 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/