Metadata-Version: 2.4
Name: sbsfuro
Version: 0.1.0
Summary: Sea-Bird Scientific Docs Theme
Author-Email: jtemplin <jtemplin@seabird.com>
License-File: LICENSE
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: Organization, https://seabird.com
Project-URL: Repository, https://github.com/Sea-BirdScientific/sbsfuro
Requires-Python: >=3.09
Requires-Dist: furo
Requires-Dist: sphinx-theme-builder[cli]
Description-Content-Type: text/markdown

# sbsfuro
A modified furo theme for Sea-Bird docs

## Use
1. Follow the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/quickstart.html) 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:
```py
html_theme = 'sbsfuro'
```
Refer to the [Community Toolkit](https://github.com/Sea-BirdScientific/seabirdscientific) for example usage.

## Develop

### Setup
```bash
uv venv
uv sync
```

### Build
```bash
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  
