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.
Source Distribution
Built Distribution
Hashes for faculty-sphinx-theme-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 826e12dca76ed56810209bc6103763135d21f9d66dd949216946cd0fc3f7d5cc |
|
MD5 | d221a67e5cb64ffe01ba509067a7e0f7 |
|
BLAKE2b-256 | 86aa3205320bdc5fb1577c71aa069aa41c23280daf91619b0a9150290bd267dc |
Hashes for faculty_sphinx_theme-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 210a61231dba6b59ef7ecc1a8a8c5f0ac410bfdd55355a23e14525d257af45c2 |
|
MD5 | 5355f845876367e615a36328507a8a45 |
|
BLAKE2b-256 | 2120f353eee9646e03840bd5e81b3b107afd365a7dd64ca061ea57cbc2dd5fdf |