x/python-cratonclient
Code Issues Proposed changes

Merge pull request #5 from ChristopherMSpencer/read_the_docs_conf

Browse Source 
updating conf to include READTHEDOCS env
This commit is contained in:
ChristopherMSpencer 2016-06-24 13:41:20 -05:00 committed by GitHub
commit 2046c486e7
1 changed files with 6 additions and 1 deletions

7
doc/source/conf.py

@ -16,6 +16,9 @@ import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
on_read_the_docs = os.environ.get('READTHEDOCS') == 'True'
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
@ -23,9 +26,11 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslosphinx'
]
if not on_read_the_docs:
extensions.append('oslosphinx')
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable