sbsfuro 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
sbsfuro-0.1.0/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2020 Pradyun Gedam <mail@pradyunsg.me>
2
+ Copyright (c) 2026 Sea-Bird Scientific <techsupport@seabird.com>
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to
6
+ deal in the Software without restriction, including without limitation the
7
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8
+ sell copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in
12
+ all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
17
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20
+ IN THE SOFTWARE.
sbsfuro-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,56 @@
1
+ Metadata-Version: 2.4
2
+ Name: sbsfuro
3
+ Version: 0.1.0
4
+ Summary: Sea-Bird Scientific Docs Theme
5
+ Author-Email: jtemplin <jtemplin@seabird.com>
6
+ License-File: LICENSE
7
+ Classifier: Framework :: Sphinx
8
+ Classifier: Framework :: Sphinx :: Theme
9
+ Classifier: Programming Language :: Python :: 3 :: Only
10
+ Classifier: Programming Language :: Python :: 3.9
11
+ Classifier: Programming Language :: Python :: 3.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Classifier: Programming Language :: Python :: 3.14
16
+ Project-URL: Organization, https://seabird.com
17
+ Project-URL: Repository, https://github.com/Sea-BirdScientific/sbsfuro
18
+ Requires-Python: >=3.09
19
+ Requires-Dist: furo
20
+ Requires-Dist: sphinx-theme-builder[cli]
21
+ Description-Content-Type: text/markdown
22
+
23
+ # sbsfuro
24
+ A modified furo theme for Sea-Bird docs
25
+
26
+ ## Use
27
+ 1. Follow the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/quickstart.html) to get that all setup for your project.
28
+ 2. Add `sbsfuro` to the `pyproject.toml` dependencies.
29
+ 3. Include the following at the end of your `conf.py` file:
30
+ ```py
31
+ html_theme = 'sbsfuro'
32
+ ```
33
+ Refer to the [Community Toolkit](https://github.com/Sea-BirdScientific/seabirdscientific) for example usage.
34
+
35
+ ## Develop
36
+
37
+ ### Setup
38
+ ```bash
39
+ uv venv
40
+ uv sync
41
+ ```
42
+
43
+ ### Build
44
+ ```bash
45
+ stb package
46
+ ```
47
+
48
+ 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.
49
+
50
+ **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*.
51
+
52
+
53
+ ## References
54
+ https://www.sphinx-doc.org/en/master/index.html
55
+ https://github.com/pradyunsg/furo
56
+ https://github.com/pradyunsg/sphinx-theme-builder
@@ -0,0 +1,34 @@
1
+ # sbsfuro
2
+ A modified furo theme for Sea-Bird docs
3
+
4
+ ## Use
5
+ 1. Follow the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/quickstart.html) to get that all setup for your project.
6
+ 2. Add `sbsfuro` to the `pyproject.toml` dependencies.
7
+ 3. Include the following at the end of your `conf.py` file:
8
+ ```py
9
+ html_theme = 'sbsfuro'
10
+ ```
11
+ Refer to the [Community Toolkit](https://github.com/Sea-BirdScientific/seabirdscientific) for example usage.
12
+
13
+ ## Develop
14
+
15
+ ### Setup
16
+ ```bash
17
+ uv venv
18
+ uv sync
19
+ ```
20
+
21
+ ### Build
22
+ ```bash
23
+ stb package
24
+ ```
25
+
26
+ 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.
27
+
28
+ **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*.
29
+
30
+
31
+ ## References
32
+ https://www.sphinx-doc.org/en/master/index.html
33
+ https://github.com/pradyunsg/furo
34
+ https://github.com/pradyunsg/sphinx-theme-builder