Metadata-Version: 2.1
Name: faculty-sphinx-theme
Version: 0.2.2
Summary: A Sphinx theme for Faculty projects.
Home-page: UNKNOWN
Author: Faculty
Author-email: opensource@faculty.ai
License: Apache Software License
Platform: UNKNOWN
Requires-Dist: sphinx-rtd-theme (==0.4.3)

faculty-sphinx-theme
====================

``faculty-sphinx-theme`` is a `Sphinx <https://www.sphinx-doc.org/>`_ theme for
`Faculty <https://faculty.ai/>`_ projects. It's based on `the Read the Docs
theme <https://sphinx-rtd-theme.readthedocs.io/>`_, but with Faculty branding
and an optional navigation bar for use in the `Faculty platform docs
<https://docs.faculty.ai>`_.

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

.. code-block:: bash

    pip install faculty-sphinx-theme

Usage
-----

Install ``faculty-sphinx-theme`` and configure your Sphinx project to use the
theme. In your project's ``conf.py``, add ``faculty_sphinx_theme`` to the list
of enabled extensions:

.. code-block:: python

    extensions = [
        "faculty_sphinx_theme",
        # Plus any other extensions you are using
    ]

and modify the ``html_theme`` setting to:

.. code-block:: python

    html_theme = "faculty-sphinx-theme"

Theme options
+++++++++++++

To enable the Faculty platform docs navigation bar, set the ``platform_navbar``
option to ``True``. The navigation bar will, by default, link to the actual
docs at `<https://docs.faculty.ai/>`_, but this can be overridden with the
``platform_navbar_root`` setting.

Example entry in ``conf.py``:

.. code-block:: python

    html_theme_options = {
        "platform_navbar": True,
        "platform_navbar_root": "/my/local/directory",
    }


