Change docs theme (#748)

* change docs theme * update theme options Signed-off-by: habibayassin <[email protected]>
The-OpenROAD-Project · Jan 5, 2023 · 9895e23 · 9895e23
1 parent 071de42
commit 9895e23
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 40 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -90,54 +90,50 @@
 html_theme = "sphinx_symbiflow_theme"
 
 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'),
-        ("The OpenROAD Project", "https://theopenroadproject.org", True, 'launch'),
-        ("GitHub", "https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts", True, 'link')
+    # Repository integration
+    # Set the repo url for the link to appear
+    'github_url': 'https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts',
+    # The name of the repo. If must be set if github_url is set
+    'repo_name': 'OpenROAD Flow',
+    # Must be one of github, gitlab or bitbucket
+    'repo_type': 'github',
+
+    # Set the name to appear in the left sidebar/header. If not provided, uses
+    # html_short_title if defined, or html_title
+    'nav_title': "OpenROAD Flow",
+
+    # A list of dictionaries where each has three keys:
+    #   href: The URL or pagename (str)
+    #   title: The title to appear (str)
+    #   internal: Flag indicating to use pathto (bool)
+    'nav_links': [
+        {"title": "Home", "href": "index", "internal": True},
+        {"title": "The OpenROAD Project", "href": "https://theopenroadproject.org", "internal": False},
     ],
 
     # 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': 'indigo',
-    # Values: Same as primary_color. (Default: pink)
-    'accent_color': 'blue',
-
-    # 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,
+    # Primary colors:
+    # red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
+    # teal, green, light-green, lime, yellow, amber, orange, deep-orange,
+    # brown, grey, blue-grey, white
+    # (Default: deep-purple)
+    'color_primary': 'indigo',
+    # Values: Same as color_primary. 
+    #(Default: indigo)
+    'color_accent': 'blue',
 
     # Hide the symbiflow links
     'hide_symbiflow_links': True,
+
+    "html_minify": False,
+    "html_prettify": True,
+    "css_minify": True,
+    "globaltoc_depth": 2,
+    "table_classes": ["plain"],
+    "master_doc": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-git+https://github.com/SymbiFlow/sphinx_materialdesign_theme.git#egg=sphinx-symbiflow-theme
+git+https://github.com/f4pga/sphinx_f4pga_theme.git
 git+https://github.com/executablebooks/sphinx-external-toc
 sphinx
 sphinx-autobuild