[LNT] r255983 - Use bootstrap for the docs theme, like the rest of LNT
Chris Matthews via llvm-commits
llvm-commits at lists.llvm.org
Thu Dec 17 19:16:22 PST 2015
Author: cmatthews
Date: Thu Dec 17 21:16:22 2015
New Revision: 255983
URL: http://llvm.org/viewvc/llvm-project?rev=255983&view=rev
Log:
Use bootstrap for the docs theme, like the rest of LNT
Modified:
lnt/trunk/docs/conf.py
Modified: lnt/trunk/docs/conf.py
URL: http://llvm.org/viewvc/llvm-project/lnt/trunk/docs/conf.py?rev=255983&r1=255982&r2=255983&view=diff
==============================================================================
--- lnt/trunk/docs/conf.py (original)
+++ lnt/trunk/docs/conf.py Thu Dec 17 21:16:22 2015
@@ -12,7 +12,7 @@
# serve to show the default.
import datetime, sys, os
-
+import sphinx_bootstrap_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -96,7 +96,66 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'nature'
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+
+html_theme_options = {
+ # Navigation bar title. (Default: ``project`` value)
+ 'navbar_title': "LNT",
+
+ # Tab name for entire site. (Default: "Site")
+ 'navbar_site_name': "Sections",
+
+ # A list of tuples containing pages or urls to link to.
+ # Valid tuples should be in the following forms:
+ # (name, page) # a link to a page
+ # (name, "/aa/bb", 1) # a link to an arbitrary relative url
+ # (name, "http://example.com", True) # arbitrary absolute url
+ # Note the "1" or "True" value above as the third argument to indicate
+ # an arbitrary url.
+ 'navbar_links': [
+ ("Back", "/", True),
+ ],
+
+ # Render the next and previous page links in navbar. (Default: true)
+ 'navbar_sidebarrel': True,
+
+ # Render the current pages TOC in the navbar. (Default: true)
+ 'navbar_pagenav': True,
+
+ # Tab name for the current pages TOC. (Default: "Page")
+ 'navbar_pagenav_name': "Page",
+
+ # Global TOC depth for "site" navbar tab. (Default: 1)
+ # Switching to -1 shows all levels.
+ 'globaltoc_depth': 2,
+
+ # Include hidden TOCs in Site navbar?
+ #
+ # Note: If this is "false", you cannot have mixed ``:hidden:`` and
+ # non-hidden ``toctree`` directives in the same page, or else the build
+ # will break.
+ #
+ # Values: "true" (default) or "false"
+ 'globaltoc_includehidden': "true",
+
+ # HTML navbar class (Default: "navbar") to attach to <div> element.
+ # For black navbar, do "navbar navbar-inverse"
+ 'navbar_class': "navbar navbar-inverse",
+
+ # Fix navigation bar to top of page?
+ # Values: "true" (default) or "false"
+ 'navbar_fixed_top': "true",
+
+ # Location of link to source.
+ # Options are "nav" (default), "footer" or anything else to exclude.
+ 'source_link_position': "nav",
+
+ # Choose Bootstrap version.
+ # Values: "3" (default) or "2" (in quotes)
+ 'bootstrap_version': "3",
+}
# 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
More information about the llvm-commits
mailing list