faculty-sphinx-theme 0.1.0

A Sphinx theme for Faculty projects.

faculty-sphinx-theme is a Sphinx theme for Faculty projects. It’s based on the Read the Docs theme, but with Faculty branding and an optional navigation bar for use in the Faculty platform docs.

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:

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

and modify the html_theme setting to:

html_theme = "faculty-sphinx-theme"

Theme options

To enable the Faculty platform docs navigation bar, set the navigation 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 navigation_root setting.

Example entry in conf.py:

html_theme_options = {
    "navigation": True,
    "navigation_root": "/my/local/directory",
}