Reference of theme options

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
`path_to_docs`	string	Path to the documentation, relative to the repository root (e.g. `docs/`). See Buttons that link to source files.
`repository_url`	string	URL of the repository for the documentation (e.g. the GitHub repository URL). See Add a link to your repository.
`repository_branch`	string	Branch of the repository for the documentation (e.g., `master`, `main`, `docs`). See Add a link to your repository.
`use_issues_button`	bool	Add an button in the header with a link to issues for the repository (used in conjunction with `repository_url` and `repository_branch`). See Add a link to your repository.
`use_download_button`	bool	Add a button in the header to download the source file of the page. See Buttons that link to source files.
`use_fullscreen_button`	bool	Add a button in the header to trigger full-screen mode.
`use_repository_button`	bool	Add a button in the header that links to the repository of the documentation.See Add a link to your repository.
`launch_buttons`	bool	Include Binder launch buttons for pages that were built from Jupyter Notebooks. See Launch buttons for interactivity.
`home_page_in_toc`	bool	Whether to put the home page in the Navigation Bar (at the top). See Add the home page to your table of contents.
`show_navbar_depth`	int	Show children in the navigation bar down to the depth listed here. See Control the depth of the left sidebar lists to expand.
`max_navbar_depth`	int	The maximum number of levels to show in the navbar. See Control the maximum depth of the left sidebar lists. (4 is default)
`collapse_navbar`	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)
`extra_navbar`	str	Extra HTML to add below the sidebar footer. See Add extra HTML to your content footer.
`extra_footer`	str	Extra HTML to add in the footer of each page.
`toc_title`	str	The text to be displayed with the in-page TOC (`Contents` is default)