Customization

Contents

Customization#

These sections describe a few ways that you may customize the look and feel of your theme.

Theme options#

The following options are available via html_theme_options

Key	Type	Description
`single_page`	bool	Remove the left sidebar and treat the site as a single page. See Use a single-page version of this theme.
`path_to_docs`	string	Path to the documentation, relative to the repository root (e.g. `docs/`). See Add buttons to link to your source.
`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 Add buttons to link to your source.
`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.
`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.
`logo_only`	bool	Only display the logo, not `html_title` if it exists.
`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.
`extra_navbar`	str	Extra HTML to add below the sidebar footer. See Customize the sidebar 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)