From c88e3cedf44c257a9dc4c00017114fca3f4e58c0 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Mon, 9 Feb 2015 13:50:29 -0800 Subject: Allow better usage of docs locally. This will default to the rtd theme and introduces tox -e docs for generating docs locally. --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/conf.py') 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()] -- cgit v1.2.1 From e7f52f2aba6fc59c0221ae08fd931fc5276d7eef Mon Sep 17 00:00:00 2001 From: John Anderson Date: Tue, 10 Feb 2015 08:59:28 -0800 Subject: Use sphinx-apidoc to to generate API docs --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 25b3d4d..ea223c2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ import os # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'sphinxcontrib.napoleon', ] @@ -57,7 +58,7 @@ copyright = u'2015, David Arthur' # The short X.Y version. with open('../VERSION') as version_file: version = version_file.read() - + # The full version, including alpha/beta/rc tags. release = version -- cgit v1.2.1