[PATCH 1/3] conf: Configure html to have github project and sidebar

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]



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 <stephen.boyd@xxxxxxxxxx>
---
 source/conf.py | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/source/conf.py b/source/conf.py
index 8f7111709646..4654e49761d2 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -133,7 +133,10 @@ html_theme = 'alabaster'
 # 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 = {
+        'github_user': 'devicetree-org',
+        'github_repo': 'devicetree-specification',
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = [alabaster.get_path()]
@@ -174,8 +177,14 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+    ]
+}
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}
-- 
2.10.0.297.gf6727b0

--
To unsubscribe from this list: send the line "unsubscribe devicetree-spec" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Device Tree]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux Audio Users]     [Photos]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]

  Powered by Linux