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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for pradyunsg from gravatar.com pradyunsg

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: Pradyun Gedam
  • Requires: Python ~=3.7
Classifiers
Report project as malware

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.

Supported by

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