documentation: improvements

docs/conf.py

@@ -15,6 +15,7 @@
 # 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.
 #sys.path.insert(0, os.path.abspath('.'))
+import os
 from docutils.parsers.rst import directives
 from sphinx.directives.code import CodeBlock
 
@@ -105,14 +106,19 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'pyramid'
-
-# 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 = {
-
-}
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    html_theme_options = {}
+else:
+    html_theme_options = {
+        'github_button': True,
+        'github_user': 'Ergo',
+        'github_repo': 'ziggurat_foundations',
+    }
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = []

docs/index.rst

@@ -30,6 +30,8 @@ further in the documentation)
 
 **BUG TRACKER**: https://github.com/ergo/ziggurat_foundations
 
+**DOCUMENTATION REPO**: https://github.com/ergo/ziggurat_foundations/docs
+
 Contents:
 
 .. toctree::