Commit 0e0fa258 by David Ormsbee

Merge pull request #20 from edx/markhoeber/documentation/config-file-update

Fixed conf.py file to work locally with RTD template and on RTD.
parents abc15bb9 49049b90
# Packages we need in order to build the docs, separated out so that rtfd.org
# can install them.
sphinx
sphinxcontrib-napoleon
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
import sys, os import sys, os
import sphinx_rtd_theme #import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
...@@ -46,6 +46,16 @@ source_suffix = '.rst' ...@@ -46,6 +46,16 @@ source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# 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()]
# General information about the project. # General information about the project.
project = u'edx-tim' project = u'edx-tim'
copyright = u'2014, edX.org' copyright = u'2014, edX.org'
...@@ -98,7 +108,7 @@ pygments_style = 'sphinx' ...@@ -98,7 +108,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = "sphinx_rtd_theme" #html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
...@@ -106,7 +116,7 @@ html_theme = "sphinx_rtd_theme" ...@@ -106,7 +116,7 @@ html_theme = "sphinx_rtd_theme"
#html_theme_options = {} #html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] #html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment