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-themeUsage
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",
}5 maintainers
Metadata
5 maintainers
Release files for faculty-sphinx-theme 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| faculty-sphinx-theme-0.2.2.tar.gz | 15.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| faculty_sphinx_theme-0.2.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 31.1 kB
Release files / faculty-sphinx-theme-0.2.2.tar.gz
| Download URL | faculty-sphinx-theme-0.2.2.tar.gz |
|---|---|
| Size | 15.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
826e12dca76ed56810209bc6103763135d21f9d66dd949216946cd0fc3f7d5cc
|
|
BLAKE2b-256 checksum How to use checksums |
86aa3205320bdc5fb1577c71aa069aa41c23280daf91619b0a9150290bd267dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Release files / faculty_sphinx_theme-0.2.2-py2.py3-none-any.whl
| Download URL | faculty_sphinx_theme-0.2.2-py2.py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
210a61231dba6b59ef7ecc1a8a8c5f0ac410bfdd55355a23e14525d257af45c2
|
|
BLAKE2b-256 checksum How to use checksums |
2120f353eee9646e03840bd5e81b3b107afd365a7dd64ca061ea57cbc2dd5fdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
