Updated doc/gui.txt and add and use Sphinx' todo extension.

[hooke.git] / doc / conf.py

diff --git a/doc/conf.py b/doc/conf.py
index 43786fd28fac7d3226d213f0e03de90d4dda0579..a93352d4f294fc3fc2f807ca69491430a8abab26 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -26,8 +26,9 @@ import hooke
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
-              'sphinx.ext.doctest', 'sphinx.ext.coverage',
-              'numpydoc']
+              'sphinx.ext.coverage', 'sphinx.ext.doctest', 
+              'sphinx.ext.intersphinx', 'sphinx.ext.pngmath',
+              'sphinx.ext.todo', 'numpydoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -197,3 +198,25 @@ latex_documents = [
 
 # If false, no module index is generated.
 #latex_use_modindex = True
+
+# -- Options for intersphinx ---------------------------------------------------
+
+intersphinx_mapping = {
+    'http://docs.python.org/dev/': None,
+    'http://docs.scipy.org/doc/numpy/': None,
+    'http://docs.scipy.org/doc/scipy/reference/': None,
+    'http://matplotlib.sourceforge.net/' : None,
+    }
+
+# -- Options for pngmath -------------------------------------------------------
+
+pngmath_latex_preamble = r"""
+\newcommand{\gaussian}{\textrm{gaussian}}
+\newcommand{\rect}{\textrm{rect}}
+\newcommand{\rfft}{\textrm{rfft}}
+\newcommand{\sinc}{\textrm{sinc}}
+"""
+
+# -- Options for todo ----------------------------------------------------------
+
+todo_include_todos = True