Updating the Sphinx configuration for new theme.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
This commit is contained in:
parent
909d06d4f6
commit
b72fa4b714
55
docs/conf.py
55
docs/conf.py
|
@ -152,53 +152,22 @@ html_theme = "sphinx_symbiflow_theme"
|
||||||
# Theme options are theme-specific and customize the look and feel of a 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
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
#
|
# https://sphinx-symbiflow-theme.readthedocs.io/en/latest/customization.html
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
# Specify a list of menu in Header.
|
'color_primary': 'light-green',
|
||||||
# Tuples forms:
|
'color_accent': 'teal',
|
||||||
# ('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'),
|
|
||||||
],
|
|
||||||
|
|
||||||
# Customize css colors.
|
# Set the repo location to get a badge with stats
|
||||||
# For details see link.
|
'github_url': 'https://github.com/google/skywater-pdk',
|
||||||
# https://getmdl.io/customize/index.html
|
'repo_name': 'google/skywater-pdk',
|
||||||
#
|
|
||||||
# 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',
|
|
||||||
|
|
||||||
# Customize layout.
|
# 'nav_links': [
|
||||||
# For details see link.
|
# ('Home', 'index', False, 'home'),
|
||||||
# https://getmdl.io/components/index.html#layout-section
|
# ("GitHub", "https://github.com/google/skywater-pdk", True, 'code'),
|
||||||
'fixed_drawer': True,
|
# ("SkyWater", "https://www.skywatertechnology.com/", True, 'link'),
|
||||||
'fixed_header': True,
|
# ],
|
||||||
'header_waterfall': True,
|
|
||||||
'header_scroll': False,
|
|
||||||
|
|
||||||
# Render title in header.
|
'globaltoc_depth': 4,
|
||||||
# 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,
|
|
||||||
|
|
||||||
# Hide the symbiflow links
|
# Hide the symbiflow links
|
||||||
'hide_symbiflow_links': True,
|
'hide_symbiflow_links': True,
|
||||||
|
|
Loading…
Reference in New Issue