OBI Sphinx Theme

A Sphinx theme for Open Brain Institute projects.

This is a thin wrapper around pydata-sphinx-theme that applies the OBI color palette:

Installation

pip install obi-sphinx-theme

Usage

In your project's conf.py:

html_theme = "obi_sphinx_theme"

The theme defaults to left-aligned navigation, the consuming repository's GitHub link, and OBI LinkedIn and Website icon links. The GitHub URL is detected from the project's origin remote and falls back to the OBI GitHub organization when no GitHub remote is available. These defaults are applied automatically, while values supplied through html_theme_options take precedence—for example, a project can replace the detected GitHub link with another URL. All pydata-sphinx-theme options remain supported via html_theme_options.

Development

# Install in development mode
pip install -e .

# Build the demo docs
cd doc
make html

License

Copyright (c) 2025 Open Brain Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See LICENSE.txt for the complete notice.