diff --git a/docs/conf.py b/docs/conf.py index 3761d887..df6615ce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -103,7 +103,7 @@ language = None exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'default' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True @@ -113,13 +113,67 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the # 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'), + ("GitHub", "https://github.com/SymbiFlow/prjxray", 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 static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/requirements.txt b/docs/requirements.txt index 4f314470..ec9e8723 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,5 @@ +sphinx_materialdesign_theme + docutils sphinx sphinx-autobuild @@ -5,7 +7,6 @@ sphinx-autobuild breathe recommonmark sphinx-markdown-tables -git+https://github.com/SymbiFlow/sphinx_symbiflow_theme sphinxcontrib-napoleon # Markdown cross-reference solver library