Skip to content

Commit 94fa59e

Browse files
bebarinorobherring
authored andcommitted
conf: Configure html to have github project and sidebar
The sidebar helps in navigating the document. Otherwise you have to go to the home page to find the other sections. Also, add the github repo information so we can link to it automatically with the "watch" button. Signed-off-by: Stephen Boyd <[email protected]> Signed-off-by: Rob Herring <[email protected]>
1 parent 7f8e2bd commit 94fa59e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

source/conf.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,10 @@ def setup(app):
133133
# Theme options are theme-specific and customize the look and feel of a theme
134134
# further. For a list of options available for each theme, see the
135135
# documentation.
136-
#html_theme_options = {}
136+
html_theme_options = {
137+
'github_user': 'devicetree-org',
138+
'github_repo': 'devicetree-specification',
139+
}
137140

138141
# Add any paths that contain custom themes here, relative to this directory.
139142
html_theme_path = [alabaster.get_path()]
@@ -174,8 +177,14 @@ def setup(app):
174177
#html_use_smartypants = True
175178

176179
# Custom sidebar templates, maps document names to template names.
177-
#html_sidebars = {}
178-
180+
html_sidebars = {
181+
'**': [
182+
'about.html',
183+
'navigation.html',
184+
'relations.html',
185+
'searchbox.html',
186+
]
187+
}
179188
# Additional templates that should be rendered to pages, maps page names to
180189
# template names.
181190
#html_additional_pages = {}

0 commit comments

Comments
 (0)