Skip to main content

A Sphinx theme for Faculty projects.

Project description

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.

Installation

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:

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 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:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for faculty-sphinx-theme, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size faculty_sphinx_theme-0.2.2-py2.py3-none-any.whl (15.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size faculty-sphinx-theme-0.2.2.tar.gz (15.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page