summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJohn Anderson <sontek@gmail.com>2015-02-09 13:50:29 -0800
committerJohn Anderson <sontek@gmail.com>2015-02-09 13:50:29 -0800
commitc88e3cedf44c257a9dc4c00017114fca3f4e58c0 (patch)
tree89f1022c8a3421bec2f1be063b5a637d26cb95ab /docs/conf.py
parent3ab9a42fcf43466f233068585f47154fbd34760b (diff)
downloadkafka-python-c88e3cedf44c257a9dc4c00017114fca3f4e58c0.tar.gz
Allow better usage of docs locally.
This will default to the rtd theme and introduces tox -e docs for generating docs locally.
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 9e95f79..25b3d4d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -262,3 +262,10 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
+
+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()]