Updating the Sphinx configuration for new theme.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
This commit is contained in:
Tim 'mithro' Ansell 2021-11-01 08:00:01 -07:00
parent 909d06d4f6
commit b72fa4b714
1 changed files with 12 additions and 43 deletions

View File

@ -152,53 +152,22 @@ html_theme = "sphinx_symbiflow_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# https://sphinx-symbiflow-theme.readthedocs.io/en/latest/customization.html
html_theme_options = {
# Specify a list of menu in Header.
# Tuples forms:
# ('Name', 'external url or path of pages in the document', boolean, 'icon name')
#
# Third argument:
# True indicates an external link.
# False indicates path of pages in the document.
#
# Fourth argument:
# Specify the icon name.
# For details see link.
# https://material.io/icons/
'header_links': [
('Home', 'index', False, 'home'),
("GitHub", "https://github.com/google/skywater-pdk", True, 'code'),
("SkyWater", "https://www.skywatertechnology.com/", True, 'link'),
],
'color_primary': 'light-green',
'color_accent': 'teal',
# Customize css colors.
# For details see link.
# https://getmdl.io/customize/index.html
#
# Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue,
# light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo)
'primary_color': 'light_green',
# Values: Same as primary_color. (Default: pink)
'accent_color': 'teal',
# Set the repo location to get a badge with stats
'github_url': 'https://github.com/google/skywater-pdk',
'repo_name': 'google/skywater-pdk',
# Customize layout.
# For details see link.
# https://getmdl.io/components/index.html#layout-section
'fixed_drawer': True,
'fixed_header': True,
'header_waterfall': True,
'header_scroll': False,
# 'nav_links': [
# ('Home', 'index', False, 'home'),
# ("GitHub", "https://github.com/google/skywater-pdk", True, 'code'),
# ("SkyWater", "https://www.skywatertechnology.com/", True, 'link'),
# ],
# Render title in header.
# Values: True, False (Default: False)
'show_header_title': False,
# Render title in drawer.
# Values: True, False (Default: True)
'show_drawer_title': True,
# Render footer.
# Values: True, False (Default: True)
'show_footer': True,
'globaltoc_depth': 4,
# Hide the symbiflow links
'hide_symbiflow_links': True,