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 链接到源文件的按钮.
repository_url	string	URL of the repository for the documentation (e.g. the GitHub repository URL). See 添加到您的仓库的链接.
repository_branch	string	Branch of the repository for the documentation (e.g., master, main, docs). See 添加到您的仓库的链接.
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 添加到您的仓库的链接.
use_download_button	bool	Add a button in the header to download the source file of the page. See 链接到源文件的按钮.
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 添加到您的仓库的链接.
launch_buttons	bool	Include Binder launch buttons for pages that were built from Jupyter Notebooks. See 用于交互的启动按钮.
home_page_in_toc	bool	Whether to put the home page in the Navigation Bar (at the top). See 将首页添加到您的目录中.
show_navbar_depth	int	Show children in the navigation bar down to the depth listed here. See 控制左侧边栏列表展开的深度.
max_navbar_depth	int	The maximum number of levels to show in the navbar. See 控制左侧边栏列表的最大深度. (4 is default)
collapse_navbar	bool	Whether to collapse the navbar, stopping the tree from being expanded. See 控制左侧边栏列表的最大深度, (False is default)
extra_navbar	str	Extra HTML to add below the sidebar footer. See 向内容页脚添加额外的HTML.
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)