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. and provide a:

  • simplified packaging experience
  • simplified JavaScript tooling setup experience
  • 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

You can 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 Contributing Guide 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.0a11.tar.gz (21.2 kB view hashes)

Uploaded Source

Built Distribution

sphinx_theme_builder-0.2.0a11-py2.py3-none-any.whl (27.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page