Configuration¶
The Xanadu Sphinx Theme supports the following options. These should be added to
the html_theme_options
dictionary in your conf.py
file.
google_analytics_tracking_id
Google Analytics tracking ID to enable website analytics.
github_repo
The GitHub organization and repository associated with the documentation. E.g., for a GitHub repository https://github.com/Organization/repo, this should be
"github_repo": "Organization/repo"
.
Table of contents¶
The following options customize the table of contents.
toc_overview
If
True
, the project name, and a link to the homepageindex.rst
, is included in the left-hand table of contents.toc_global
Whether to show the global table of contents by default via the left sidebar. If
False
, then the left sidebar will be disabled.toc_subset
If set to
True
, and the current page has no local table of contents, the right-hand table of contents will instead display the current subset of the document tree. That is, the right-hand ToC will display the location in the document of the current page. IfFalse
, and the current page has no local table of contents, no right-hand ToC will be shown.relations
If
True
, then Next and Previous buttons are included at the bottom of every page, allowing navigation according to the table of contents.
Style Colours¶
The following options allow the colours of various theme elements to be altered.
These should be fully qualified CSS color specifiers such as #004B6B
or
#444
.
border_colour
Border colour of accent rules and table headers.
code_colour
Colour of code blocks and teletype text. Defaults to
#8D1A38
.prev_next_button_colour
andprev_next_button_hover_colour
Colours of the “Next” and “Previous” navigation buttons located at the bottom of most pages.
social_icon_colour
Colour of the social icons.
table_header_background_colour
Background colour of table headers.
text_accent_colour
Accent colour for text such as download links.
toc_marker_colour
Colour of the marker beside the current ToC entry.
toc_mobile_heading_colour
andtoc_mobile_heading_background_colour
Text and background colours of the mobile ToC heading.