Skip to main content

A tool for authoring Sphinx themes with a simple (opinionated) workflow.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-theme-builder-0.2.0a15.tar.gz (22.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page