faculty-sphinx-theme

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",
}

Metadata

Release files for faculty-sphinx-theme 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for faculty-sphinx-theme 0.2.1
File	Size	Uploaded
faculty-sphinx-theme-0.2.1.tar.gz	15.8 kB	Apr 15, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for faculty-sphinx-theme 0.2.1
File	Interpreter	ABI	Platform	Reset
faculty_sphinx_theme-0.2.1-py2.py3-none-any.whl 16.1 kB Apr 15, 2020	Python 3, Python 2	none	any	Details

Total release size: 31.9 kB

Release files / faculty-sphinx-theme-0.2.1.tar.gz

Download URL	faculty-sphinx-theme-0.2.1.tar.gz
Size	15.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`4509f595159ee9a04cc616c55a2ab5426a63d9abbf74776fca4521bcba634067`
BLAKE2b-256 checksum How to use checksums	`cec5ce1bba603e40bac35de3ddfd97617fcd2a896e9fd96b068088c317271d13`
Upload date	Apr 15, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2`

Release files / faculty_sphinx_theme-0.2.1-py2.py3-none-any.whl

Download URL	faculty_sphinx_theme-0.2.1-py2.py3-none-any.whl
Size	16.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`d6760e19dd640966083b9c127ff256e29df91ef7000e96d72ae6a2d03424e599`
BLAKE2b-256 checksum How to use checksums	`8cea77a04d6b5210317937593adc81860ea49d40daf7d2fc19683bf83d27d6d5`
Upload date	Apr 15, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2`