update and tweak docs theme, add tutorial skeletons and overview to gstlal-burst code

doc/source/conf.py

@@ -98,20 +98,27 @@ todo_include_todos = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'classic'#'alabaster'
+html_theme = 'alabaster'#'classic'
 html_logo = "gstlal.png"
 
 # 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
 # documentation.
-#
-# html_theme_options = {}
+html_theme_options = {
+    'fixed_sidebar': 'true',
+    'sidebar_width': '300px',
+    'page_width': '1800px',
+    'show_powered_by': 'false',
+    'logo_name': 'true',
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = { '**': ['navigation.html', 'relations.html', 'searchbox.html'] }
 
 # -- Options for HTMLHelp output ------------------------------------------
 

doc/source/gstlal-burst/gstlal-burst.rst

-GstLAL burst project
-====================
+####################################################################################################
+GstLAL burst
+####################################################################################################
+
+`GstLAL burst` contains several projects targeting a variety of different searches. These include:
+
+  * **Feature extraction:** Identify noise transient bursts (glitches) in auxiliary channel data.
+  * **Cosmic string search**
+  * **Excess power**
+
+Contents
+-------------------------
 
 .. toctree::
    :maxdepth: 2
 
    overview
+   tutorials/tutorials
    code

doc/source/gstlal-burst/overview.rst

+####################################################################################################
 Overview
-========
+####################################################################################################
 
-FIXME
+.. _burst-overview-feature_extraction:
+
+Feature Extraction
+====================================================================================================
+
+The `fxtools` module contains relevant libraries to identify glitches in low-latency using auxiliary
+channel data.

doc/source/gstlal-burst/tutorials/running_offline_jobs.rst

+####################################################################################################
+Running Offline Jobs
+####################################################################################################
+
+TODO

doc/source/gstlal-burst/tutorials/running_online_jobs.rst

+####################################################################################################
+Running Online Jobs
+####################################################################################################
+
+TODO

doc/source/gstlal-burst/tutorials/tutorials.rst

+####################################################################################################
+Tutorials
+####################################################################################################
+
+.. toctree::
+       :maxdepth: 2
+
+    running_online_jobs
+    running_offline_jobs

doc/source/gstlal-calibration/gstlal-calibration.rst

-GstLAL calibration project
+GstLAL calibration
 ==========================
 
 .. toctree::

doc/source/gstlal-inspiral/gstlal-inspiral.rst

-GstLAL inspiral project
+GstLAL inspiral
 =======================
 
 .. toctree::

doc/source/gstlal-ugly/gstlal-ugly.rst

-GstLAL ugly project
+GstLAL ugly
 ===================
 
 .. toctree::

doc/source/gstlal/gstlal.rst

-GstLAL project
+GstLAL
 ==============
 
 .. toctree::