Change theme to sphinx-bootstrap-theme with yeti

Author: Poulter, Roland

docs/_templates/sourcelink.html

@@ -1,6 +1,7 @@
 {%- if show_source and has_source and sourcename %}
-  <h3>{{ _('This Page') }}</h3>
-  <ul class="this-page-menu">
+  <!-- <h3>{{ _('This Page') }}</h3> -->
+  <!-- <ul class="this-page-menu"> -->
+  <ul class="nav navbar-nav navbar-right">
     <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
            rel="nofollow">{{ _('Show Source') }}</a></li>
   {%- if show_on_github_url %}
@@ -11,5 +12,10 @@ <h3>{{ _('This Page') }}</h3>
     <li><a href="{{ edit_on_github_url }}"
            rel="nofollow">{{ _('Edit on GitHub') }}</a></li>
   {%- endif %}
+    <li>
+        <a href="https://emccode.github.io">
+            <i class="fa icon-emccode-logo"></i>
+        </a>
+    </li>
   </ul>
 {%- endif %}

docs/conf.py

@@ -14,9 +14,8 @@
 
 import sys
 import os
-import sphinx_rtd_theme
+import sphinx_bootstrap_theme
 
-# import sphinx_bootstrap_theme
 #import shlex
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -115,15 +114,72 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = 'alabaster'
-html_theme = "sphinx_rtd_theme"
-# html_theme = 'bootstrap'
-# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path(c:\python27\lib\site-packages)
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()#c:\python27\lib\site-packages)
 
 # 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 = {
+    # Navigation bar title. (Default: ``project`` value)
+    'navbar_title': "RackHD",
+
+    # Tab name for entire site. (Default: "Site")
+    'navbar_site_name': "RackHD",
+
+    # 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': [
+    #     ("Examples", "examples"),
+    #     ("Link", "http://example.com", True),
+    # ],
+
+    # Render the next and previous page links in navbar. (Default: true)
+    # 'navbar_sidebarrel': False,
+
+    # Render the current pages TOC in the navbar. (Default: true)
+    # 'navbar_pagenav': False,
+
+    # Tab name for the current pages TOC. (Default: "Page")
+    'navbar_pagenav_name': "Docs",
+
+    # 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': "false",
+
+    # 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",
+
+    # Bootswatch (http://bootswatch.com/) theme.
+    # Options are nothing (default) or the name of a valid theme
+    # such as "amelia", "cosmo", or "united".
+    'bootswatch_theme': "yeti",
+
+    # Choose Bootstrap version.
+    # Values: "3" (default) or "2" (in quotes)
+    # 'bootstrap_version': "2",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

requirements.txt

@@ -17,6 +17,6 @@ six==1.9.0
 snowballstemmer==1.2.0
 Sphinx==1.3.1
 sphinx-autobuild==0.5.2
-sphinx-rtd-theme==0.1.8
+sphinx-bootstrap-theme==0.4.8
 tornado==4.2.1
 watchdog==0.8.3