How-To for Visualization of Results

- added an elaborate how-to on visualizing results
- added a subsection about heatmap normalization
- added a subsection about color maps, which shows built-in color maps
  and how to use them
- added a subsection on the Color-Map Specification Language (CMSL),
  with a simple grammar specification, a detailed explanation of its
  workings and a few examples along visualizations
- added a subsection on changing palettes
- added compile-time visualizations of heatmaps using
  sphinxcontrib.datatemplates
- added sphinx.datatemplates requirement
- added config option `generated_path` to choose where generated images
  should be stored

docs/requirements.txt

@@ -1,2 +1,3 @@
 sphinx-copybutton>=0.4.0
 sphinx-rtd-theme>=1.0.0
+sphinxcontrib.datatemplates>=0.9.0

docs/source/conf.py

@@ -39,9 +39,20 @@
  'sphinx.ext.imgmath',
  'sphinx.ext.extlinks',
  'sphinx_rtd_theme',
- 'sphinx_copybutton'
+ 'sphinx_copybutton',
+ 'sphinxcontrib.datatemplates',
 ]
 
+
+def config_inited_handler(app, config):
+ os.makedirs(os.path.join(app.srcdir, app.config.generated_path), exist_ok=True)
+
+
+def setup(app):
+ app.add_config_value('generated_path', '_generated', 'env')
+ app.connect('config-inited', config_inited_handler)
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']