sets up RTD theme for local docs development

ramses-tech · Apr 5, 2015 · 1b7e4b6 · 1b7e4b6
1 parent c117098
commit 1b7e4b6
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -113,6 +113,16 @@
 
 # -- Options for HTML output ----------------------------------------------
 
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
+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()]
+
+# otherwise, readthedocs.org uses their theme by default, so no need to specify it
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 # html_theme = 'alabaster'

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,6 +19,7 @@ Contents
 
 .. toctree::
    :maxdepth: 2
+   :includehidden:
 
    getting_started
    engines