https://github.com/beeware/beeware-theme
A set of Furo theme extensions to make a Sphinx site have BeeWare site branding.
https://github.com/beeware/beeware-theme
Last synced: 5 months ago
JSON representation
A set of Furo theme extensions to make a Sphinx site have BeeWare site branding.
- Host: GitHub
- URL: https://github.com/beeware/beeware-theme
- Owner: beeware
- License: other
- Created: 2025-06-19T02:52:48.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-06-19T03:36:10.000Z (12 months ago)
- Last Synced: 2025-06-19T03:36:35.275Z (12 months ago)
- Language: HTML
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BeeWare Theme Templates
**NOTE: This repository has been archived. It was used by Sphinx builds of BeeWare project documentation that had the shared documentation header (Briefacse 0.3.25, Toga 0.5.2, and Rubicon-ObjC 0.5.2). However, with the move to MkDocs for project documentation (completed October 2025) it is no longer required.**
A collection of template files to override the [Furo Sphinx theme](https://github.com/pradyunsg/furo) with BeeWare header and sidebar branding.
## Usage
These template files are designed to override the Furo Sphinx theme, and will therefore only work if the Furo theme is enabled. The following is required to enable these theme elements on a BeeWare repository's Read the Docs documentation.
1. Update the `pyproject.toml` `[docs]` extra list to include the following:
```toml
"beeware_theme @ git+https://github.com/beeware/beeware-theme",
```
2. Add the following to `docs/conf.py`:
```python
import beeware_theme
templates_path = []
html_static_path = []
html_css_files = []
html_context = {}
html_theme_options = {}
beeware_theme.init(
project_name="my_project",
templates=templates_path,
context=html_context,
static=html_static_path,
css=html_css_files,
theme_options=html_theme_options,
)
```
In this configuration, ``my_project`` is the GitHub project name. You can put
any other content in ``template_paths``, ``html_static_path``,
``html_css_files``, ``html_context`` or ``html_theme_options`` as is required by the
local project.
## Testing
To test this theme, create a virtual environment, and run:
```
(venv) $ pip install -e ".[dev]"
(venv) $ tox -e docs-live
```
This will serve a test project with the theme applied.