Clean up of conf.py

conf.py

@@ -2,9 +2,8 @@
 
 import sys
 import os
-import shlex
 import sphinx_rtd_theme
-#import subprocess
+import subprocess
 
 import sphinxcontrib.katex as katex
 
@@ -13,129 +12,70 @@
 from definitions import acronyms      # This includes things like |HRTF|
 from definitions import latex_macros  # Math definitions like \x
 
-def setup(app):
-    """Include custom theme files to sphinx HTML header"""
-    app.add_stylesheet('css/abbr.css')
-
 
-# -- General configuration ------------------------------------------------
+# -- GENERAL -------------------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.3'
+project = 'Sound Field Synthesis'
+copyright = '2016-2017, SFS Toolbox Developers'
+author = 'SFS Toolbox Developers'
 
-# 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','nbsphinx','sphinx.ext.mathjax']
+needs_sphinx = '1.3'   # minimal sphinx version
 extensions = [
-	'sphinx.ext.autodoc',
-	'sphinx.ext.viewcode',
+        'sphinx.ext.autodoc',
+        'sphinx.ext.viewcode',
         'sphinxcontrib.katex',
         'matplotlib.sphinxext.plot_directive'
 ]
-
-# Enable numbering of figures and tables
-numfig = True
-
-# Plot settings for matplot
-plot_include_source = True
-plot_html_show_source_link = False
-plot_html_show_formats = False
-plot_formats = ['png']
-plot_rcparams = {'figure.figsize' : [8, 4.5] }
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
 master_doc = 'index'
-
-# General information about the project. (substitutions)
-project = 'Sound Field Synthesis'
-copyright = '2016, SFS Toolbox Developers'
-author = 'SFS Toolbox Developers'
+source_suffix = '.rst'
+exclude_patterns = ['_build']
 
 # The full version, including alpha/beta/rc tags.
 #release = version
 try:
-    release = check_output(['git', 'describe', '--tags', '--always'])
+    release = subprocess.check_output(
+            ['git', 'describe', '--tags', '--always'])
     release = release.decode().strip()
 except Exception:
     release = '<unknown>'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
 
-# If true, '()' will be appended to :func: etc. cross-reference text.
-add_function_parentheses = True
+# -- FIGURES AND CODE ----------------------------------------------------
 
-# The name of the Pygments (syntax highlighting) style to use.
-#pygments_style = 'sphinx'
-pygments_style = 'trac'
+# Enable numbering of figures and tables
+numfig = True
+# Plot settings for matplot
+plot_include_source = True
+plot_html_show_source_link = False
+plot_html_show_formats = False
+plot_formats = ['png']
+plot_rcparams = {'figure.figsize': [8, 4.5]}
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
+# Code syntax highlighting style
+pygments_style = 'trac'
 
 
 # -- ACRONYMS AND MATH ---------------------------------------------------
 rst_epilog = acronyms  # append acronyms to every page
 katex_macros = katex.latex_defs_to_katex_macros(latex_macros)
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
 
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# -- HTML ----------------------------------------------------------------
 
-# Include custom files from _static folder
-html_static_path = ['_static']
+def setup(app):
+    """Include custom theme files to sphinx HTML header"""
+    app.add_stylesheet('css/abbr.css')
 
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
+html_theme = "sphinx_rtd_theme"
+html_static_path = ['_static']
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme_options = {'display_version': True}
 html_title = "SFS Toolbox"
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
 html_short_title = ""
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-html_show_sphinx = False
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-#html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# Now only 'ja' uses this config value
-#html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = 'sfs-doc'
 
 
-# -- Options for LaTeX output ---------------------------------------------
+# -- LATEX ---------------------------------------------------------------
 
 latex_elements = {
         'papersize': 'a4paper',