sbsfuro
A modified furo theme for Sea-Bird docs
Use
- Follow the Sphinx docs to get that all setup for your project.
- Add
sbsfuroto thepyproject.tomldependencies. - Include the following at the end of your
conf.pyfile:
html_theme = 'sbsfuro'
Refer to the Community Toolkit for example usage.
Develop
Setup
uv venv
uv sync
Build
stb package
This will run npm run build, py -m build, and some other magic. If all goes well, it will produce a .whl file in the dist folder which can be installed and used as a sphinx theme.
Note: The stb package command will only include files in the static folder if they are part of the npm build step or if they are tracked by git.
References
https://www.sphinx-doc.org/en/master/index.html
https://github.com/pradyunsg/furo
https://github.com/pradyunsg/sphinx-theme-builder
1 maintainer
Release files for sbsfuro 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sbsfuro-0.1.0.tar.gz | 239.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sbsfuro-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 445.3 kB
Release files / sbsfuro-0.1.0.tar.gz
| Download URL | sbsfuro-0.1.0.tar.gz |
|---|---|
| Size | 239.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9452b8e2cf0bf84d74aff4743dc10b81fe01d1f43b1a2f997457cff61ad631ae
|
|
BLAKE2b-256 checksum How to use checksums |
7fa5d7290ff525911593a0e70e0494f9cfd1fed1a3678aa88a9653c866f2894c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / sbsfuro-0.1.0-py3-none-any.whl
| Download URL | sbsfuro-0.1.0-py3-none-any.whl |
|---|---|
| Size | 205.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c64dc7e2c5064d3d4f621da493c39e99b5256517bd62b82e6ed434c6f0fc3cb6
|
|
BLAKE2b-256 checksum How to use checksums |
58c0fc07e05950bcca3fca2702efacbac458140a15d1fd3cc35a10a8f5239c6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
