Merge pull request #19 from antmicro/sphinx_material_design

Change theme to Sphinx Material Design
This commit is contained in:
Tim Ansell 2019-09-27 02:47:25 -07:00 committed by GitHub
commit 072b35cc8d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 4 deletions

View File

@ -1,2 +1,2 @@
git+https://github.com/SymbiFlow/sphinx_symbiflow_theme sphinx_materialdesign_theme
sphinx-markdown-tables sphinx-markdown-tables

View File

@ -39,7 +39,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'SymbiFlow - documentation' project = u'SymbiFlow'
basic_filename = u'symbiflow-docs' basic_filename = u'symbiflow-docs'
authors = u'SymbiFlow' authors = u'SymbiFlow'
copyright = authors + u', 2019' copyright = authors + u', 2019'
@ -92,12 +92,58 @@ pygments_style = 'default'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = "sphinx_symbiflow_theme" html_theme = "sphinx_materialdesign_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.
#html_theme_options = {} 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'),
("Website", "https://symbiflow.github.io", True, 'launch'),
("GitHub", "https://github.com/SymbiFlow", True, 'link')
],
# 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': 'deep_purple',
# Values: Same as primary_color. (Default: pink)
'accent_color': 'purple',
# 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,
# 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
}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = None #html_theme_path = None