OBI Sphinx Theme
================

A Sphinx theme for Open Brain Institute projects, based on
`pydata-sphinx-theme <https://pydata-sphinx-theme.readthedocs.io/>`_.

Installation
------------

.. code-block:: bash

   pip install obi-sphinx-theme

Usage
-----

In your project's ``conf.py``:

.. code-block:: python

   html_theme = "obi_sphinx_theme"

That's it. The theme inherits all features from pydata-sphinx-theme and
applies the OBI color palette (navy brand, light-blue selections,
soft blue-grey panels). It also 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.

Configuration
-------------

All ``html_theme_options`` from pydata-sphinx-theme are supported. Values
provided by a project override the theme defaults—for example, a project can
replace the detected GitHub link with another URL.
See the `pydata-sphinx-theme docs <https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/index.html>`_
for the full list.

.. toctree::
   :hidden:
   :maxdepth: 2

   Home <self>
   sample