Reference of theme options#
The following theme-specific options are available via html_theme_options
.
See the PyData Theme as well
These are in addition to all of the options available in the PyData Sphinx Theme.
Key |
Type |
Description |
---|---|---|
|
string |
Path to the documentation, relative to the repository root (e.g. |
|
string |
URL of the repository for the documentation (e.g. the GitHub repository URL). See Add a link to your repository. |
|
string |
Branch of the repository for the documentation (e.g., |
|
bool |
Add an button in the header with a link to issues for the repository (used in conjunction with |
|
bool |
Add a button in the header to download the source file of the page. See Buttons that link to source files. |
|
bool |
Add a button in the header to trigger full-screen mode. |
|
bool |
Add a button in the header that links to the repository of the documentation.See Add a link to your repository. |
|
bool |
Include Binder launch buttons for pages that were built from Jupyter Notebooks. See Launch buttons for interactivity. |
|
bool |
Whether to put the home page in the Navigation Bar (at the top). See Add the home page to your table of contents. |
|
int |
Show children in the navigation bar down to the depth listed here. See Control the depth of the left sidebar lists to expand. |
|
int |
The maximum number of levels to show in the navbar. See Control the maximum depth of the left sidebar lists. (4 is default) |
|
bool |
Whether to collapse the navbar, stopping the tree from being expanded. See Control the maximum depth of the left sidebar lists, (False is default) |
|
str |
Extra HTML to add below the sidebar footer. See Add extra HTML to your content footer. |
|
str |
Extra HTML to add in the footer of each page. |
|
str |
The text to be displayed with the in-page TOC ( |