implement BoundlessGeo sphinx_rtd_theme based on GDAL.org

doc/conf.py

@@ -140,26 +140,46 @@ def read_version(filename):
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'rtd_theme'
+html_theme = 'pdal_rtd'
+html_theme_path = ['.']
+html_title = "pdal.io"
 
-# 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.
 
-# Add any paths that contain custom themes here, relative to this directory.
+html_context = {
+  'display_github': True,
+  'theme_vcs_pageview_mode': 'edit',
+  'github_user': 'PDAL',
+  'github_repo': 'PDAL',
+  'github_version': '/master/doc/'
+}
+
+html_theme_options = {
+    'canonical_url': 'https://pdal.io/',
+    'analytics_id': '',  #  Provided by Google in your dashboard
+    'logo_only': True,
+    'display_version': True,
+    'prev_next_buttons_location': 'both',
+    'style_external_links': False,
+    #'vcs_pageview_mode': '',
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    #'navigation_depth': 4,
+    'includehidden': True,
+    'logo_only': True,
+    'titles_only': False
+}
 
-#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-html_theme_path = ['.']
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-html_title = "pdal.io"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 html_short_title = "Documentation"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-# html_logo = './_static/pdal_logo_small.png'
+#html_logo = './_static/pdal_logo_small.png'
+#html_logo = './_static/logo/pdal_logo_only.png'
+
+theme_logo_only=False
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

doc/rtd_theme/footer.html → doc/pdal_rtd/footer.html

@@ -1,31 +1,34 @@
 <footer>
-  {% if next or prev %}
+  {% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       {% if next %}
-        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
       {% endif %}
       {% if prev %}
-        <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
       {% endif %}
     </div>
   {% endif %}
 
   <hr/>
 
   <div role="contentinfo">
-    <p>
-    {%- if show_copyright %}
+    <div class="info">
+      <a class="logo-link" href="https://hobu.co">
+        <div class="hobu-logo"></div>
+      </a>
+      <div class="copyright">
+      {% if copyright %}
+
                     &copy;  {{ copyright }}
                         <a href="https://github.com/abellgithub">Andrew Bell</a>,
                         <a href="https://github.com/chambbj">Brad Chambers</a>,
                         <a href="http://github.com/hobu">Howard Butler</a>,
-                        <a href="http://github.com/mpgerlek">Michael Gerlek</a>,
                         and
                         <a href="https://github.com/PDAL/PDAL/graphs/contributors">others</a>.
 
-    {%- endif %}
-
-    {%- if build_id and build_url %}
+      {% endif %}
+   {%- if build_id and build_url %}
       {% trans build_url=build_url, build_id=build_id %}
         <span class="build">
           Build
@@ -41,11 +44,6 @@
     {%- elif last_updated %}
       {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
     {%- endif %}
-
-    </p>
-  </div>
-
-  {%- block extrafooter %} {% endblock %}
-
+      </div>
+    </div>
 </footer>
-

doc/_templates/pdal_rtd/static/css/gdal.css → doc/pdal_rtd/static/css/pdal.css

@@ -199,9 +199,9 @@ a.reference.external::after
 
 .wy-side-nav-search
 {
-	margin-bottom: unset;
-	padding-bottom: unset;
-	background-color: #28728d;
+	background-color: #2d7eb8;
+	background: #2d7eba;
+    color: white;
 }
 
 /*  Use sidebar versions area to link to course name */
@@ -213,7 +213,7 @@ a.reference.external::after
 /* Override wy-nav colors to match company branding */
 .wy-side-nav-search, .wy-side-nav-search img, .wy-nav .wy-menu-vertical header, .wy-nav-top, .wy-nav-top img
 {
-	  background-color: #28728d;
+	  background-color: #2d7eb8;
 }
 
 /* center figures and captions */
@@ -275,11 +275,11 @@ div[class ^= "admonition-demo"] > p.admonition-title
     background-color: #f58d50;
 }
 
-footer .logo-link .osgeo-logo
+footer .logo-link .hobu-logo
 {
-	background: url("../img/osgeo-emblem-24x24.png") no-repeat;
-	height: 24px;
-	width: 24px;
+	background: url("../img/hobu-emblem-32x32.png") no-repeat;
+	height: 32px;
+	width: 32px;
 	display: inline-block;
 }
 

doc/_templates/pdal_rtd/theme.conf → doc/pdal_rtd/theme.conf

@@ -1,6 +1,6 @@
 [theme]
 inherit = sphinx_rtd_theme
-stylesheet = css/gdal.css
+stylesheet = css/pdal.css
 pygments_style = trac
 
 [options]