File: README.md

package info (click to toggle)
sphinx-theme-builder 0.2.0b2-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 448 kB
  • sloc: python: 2,227; sh: 19; makefile: 3
file content (43 lines) | stat: -rw-r--r-- 1,097 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# 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/