|
@@ -20,21 +20,18 @@
|
|
|
import sys
|
|
|
import os
|
|
|
import shlex
|
|
|
-import sphinx_rtd_theme
|
|
|
|
|
|
-# 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
|
|
|
-# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
-sys.path.insert(0, os.path.abspath('..'))
|
|
|
-from recommonmark.parser import CommonMarkParser
|
|
|
-source_parsers = {'.md': CommonMarkParser}
|
|
|
-source_suffix = ['.rst', '.md']
|
|
|
+# For conversion from markdown to html
|
|
|
+import recommonmark.parser
|
|
|
+
|
|
|
+# Set paths
|
|
|
+#sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
|
#
|
|
|
-# needs_sphinx = '1.0'
|
|
|
+needs_sphinx = '1.4'
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
@@ -119,6 +116,13 @@ pygments_style = 'sphinx'
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
|
todo_include_todos = False
|
|
|
|
|
|
+# -- Source -------------------------------------------------------------
|
|
|
+
|
|
|
+source_parsers = {
|
|
|
+ '.md': 'recommonmark.parser.CommonMarkParser',
|
|
|
+}
|
|
|
+
|
|
|
+source_suffix = ['.rst', '.md']
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
|
@@ -336,3 +340,15 @@ texinfo_documents = [
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
|
#
|
|
|
# texinfo_no_detailmenu = False
|
|
|
+
|
|
|
+# -- Read The Docs --------------------------------------------------------
|
|
|
+
|
|
|
+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()]
|
|
|
+
|
|
|
+# readthedocs.org uses their theme by default, so no need to specify it
|