sbsfuro 0.1.0

Sea-Bird Scientific Docs Theme

sbsfuro

A modified furo theme for Sea-Bird docs

Use

1. Follow the Sphinx docs to get that all setup for your project.
2. Add sbsfuro to the pyproject.toml dependencies.
3. Include the following at the end of your conf.py file:

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