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.

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

Download files

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

Source Distribution

faculty-sphinx-theme-0.1.0.tar.gz (15.5 kB view details)

Uploaded Apr 9, 2020 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

faculty_sphinx_theme-0.1.0-py2.py3-none-any.whl (15.3 kB view details)

Uploaded Apr 9, 2020 Python 2Python 3

File details

Details for the file faculty-sphinx-theme-0.1.0.tar.gz.

File metadata

Download URL: faculty-sphinx-theme-0.1.0.tar.gz
Upload date: Apr 9, 2020
Size: 15.5 kB
Tags: Source
Uploaded using 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

File hashes

Hashes for faculty-sphinx-theme-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`de2b6d5b43e10da91c1bd59ab6f47952a6dceaba0cdffe754c90334339efeda7`
MD5	`d74b0e71ea83d64eaded0e95182cc6ca`
BLAKE2b-256	`28d6c5bd7d76425198cc1954ea033c12b1de0b4447002ce5782d846d86670dbd`

See more details on using hashes here.

File details

Details for the file faculty_sphinx_theme-0.1.0-py2.py3-none-any.whl.

File metadata

Download URL: faculty_sphinx_theme-0.1.0-py2.py3-none-any.whl
Upload date: Apr 9, 2020
Size: 15.3 kB
Tags: Python 2, Python 3
Uploaded using 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

File hashes

Hashes for faculty_sphinx_theme-0.1.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`5de8516c688544258c78d53808612795c0a1e505454963678774a9d7523fa939`
MD5	`e3527912dc5a2c367c864f125dc39ba8`
BLAKE2b-256	`11d582d4e0f7674fd37c3f20c9513b7f1a722ba11936d4cde6bdf46780ba9401`