|
94 | 94 | html_theme = "sphinx_symbiflow_theme" |
95 | 95 |
|
96 | 96 | html_theme_options = { |
97 | | - # Specify a list of menu in Header. |
98 | | - # Tuples forms: |
99 | | - # ('Name', 'external url or path of pages in the document', boolean, 'icon name') |
100 | | - # |
101 | | - # Third argument: |
102 | | - # True indicates an external link. |
103 | | - # False indicates path of pages in the document. |
104 | | - # |
105 | | - # Fourth argument: |
106 | | - # Specify the icon name. |
107 | | - # For details see link. |
108 | | - # https://material.io/icons/ |
109 | | - 'header_links': [ |
110 | | - ('Home', 'index', False, 'home'), |
111 | | - ("The OpenROAD Project", "https://theopenroadproject.org", True, 'launch'), |
112 | | - ("GitHub", "https://github.com/The-OpenROAD-Project/OpenROAD", True, 'link') |
| 97 | + # Repository integration |
| 98 | + # Set the repo url for the link to appear |
| 99 | + 'github_url': 'https://github.com/The-OpenROAD-Project/OpenROAD', |
| 100 | + # The name of the repo. If must be set if github_url is set |
| 101 | + 'repo_name': 'OpenROAD', |
| 102 | + # Must be one of github, gitlab or bitbucket |
| 103 | + 'repo_type': 'github', |
| 104 | + |
| 105 | + # Set the name to appear in the left sidebar/header. If not provided, uses |
| 106 | + # html_short_title if defined, or html_title |
| 107 | + 'nav_title': "OpenROAD", |
| 108 | + |
| 109 | + # A list of dictionaries where each has three keys: |
| 110 | + # href: The URL or pagename (str) |
| 111 | + # title: The title to appear (str) |
| 112 | + # internal: Flag indicating to use pathto (bool) |
| 113 | + 'nav_links': [ |
| 114 | + {"title": "Home", "href": "index", "internal": True}, |
| 115 | + {"title": "The OpenROAD Project", "href": "https://theopenroadproject.org", "internal": False}, |
113 | 116 | ], |
114 | 117 |
|
115 | 118 | # Customize css colors. |
116 | 119 | # For details see link. |
117 | 120 | # https://getmdl.io/customize/index.html |
118 | 121 | # |
119 | | - # Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue, |
120 | | - # light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo) |
121 | | - 'primary_color': 'indigo', |
122 | | - # Values: Same as primary_color. (Default: pink) |
123 | | - 'accent_color': 'blue', |
124 | | - |
125 | | - # Customize layout. |
126 | | - # For details see link. |
127 | | - # https://getmdl.io/components/index.html#layout-section |
128 | | - 'fixed_drawer': True, |
129 | | - 'fixed_header': True, |
130 | | - 'header_waterfall': True, |
131 | | - 'header_scroll': False, |
132 | | - |
133 | | - # Render title in header. |
134 | | - # Values: True, False (Default: False) |
135 | | - 'show_header_title': False, |
136 | | - # Render title in drawer. |
137 | | - # Values: True, False (Default: True) |
138 | | - 'show_drawer_title': True, |
139 | | - # Render footer. |
140 | | - # Values: True, False (Default: True) |
141 | | - 'show_footer': True, |
| 122 | + # Primary colors: |
| 123 | + # red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, |
| 124 | + # teal, green, light-green, lime, yellow, amber, orange, deep-orange, |
| 125 | + # brown, grey, blue-grey, white |
| 126 | + # (Default: deep-purple) |
| 127 | + 'color_primary': 'indigo', |
| 128 | + # Values: Same as color_primary. |
| 129 | + #(Default: indigo) |
| 130 | + 'color_accent': 'blue', |
142 | 131 |
|
143 | 132 | # Hide the symbiflow links |
144 | 133 | 'hide_symbiflow_links': True, |
| 134 | + |
| 135 | + "html_minify": False, |
| 136 | + "html_prettify": True, |
| 137 | + "css_minify": True, |
| 138 | + "globaltoc_depth": 2, |
| 139 | + "table_classes": ["plain"], |
| 140 | + "master_doc": False, |
145 | 141 | } |
146 | 142 |
|
147 | 143 | # Add any paths that contain custom static files (such as style sheets) here, |
|
0 commit comments