update doc theme, tidy up front page

.gitlab-ci.yml

@@ -368,7 +368,7 @@ pages:
   script:
     - echo "Building Documentation"
     - yum -y install python2-pip
-    - pip install setuptools sphinx==1.7
+    - pip install setuptools sphinx==1.7 sphinx_rtd_theme
     - export GSTLAL_FIR_WHITEN=0
     - export TMPDIR=tmp/ 
     - cd doc; make html

doc/source/_static/css/my_theme.css

+/* Uses skorch docs theme from https://skorch.readthedocs.io */
+
+.wy-side-nav-search {
+    background-color: #fcfcfc;
+
+}
+
+.wy-side-nav-search > div.version {
+    color: black;
+}
+
+.wy-side-nav-search > a {
+    color: black;
+}
+
+/* Adds logo in header for mobile */
+
+.wy-nav-top {
+    background-color: #fcfcfc;
+    background-image: url('../logo.svg');
+    background-repeat: no-repeat;
+    background-position: bottom;
+    padding: 0;
+    margin: 0.4045em 0.809em;
+    color: #333;
+}
+
+.wy-nav-top > a {
+    display: none;
+}

doc/source/_templates/layout.html

+{%- set logo = "gstlal.png" %}
+{% extends "!layout.html" %}

doc/source/conf.py

@@ -25,6 +25,9 @@ sys.path.insert(0, os.path.abspath('../../gstlal-burst/python'))
 sys.path.insert(0, os.path.abspath('../../gstlal-calibration/python'))
 sys.path.insert(0, os.path.abspath('../../gstlal-ugly/python'))
 
+#  on_rtd is whether we are on readthedocs.org, this line of code grabbed
+#  from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 # -- General configuration ------------------------------------------------
 
@@ -35,7 +38,8 @@ sys.path.insert(0, os.path.abspath('../../gstlal-ugly/python'))
 # 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',
+extensions = [
+    'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
@@ -98,28 +102,29 @@ 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 = 'alabaster'#'classic'
-html_logo = "gstlal_small.png"
+html_theme = 'default'
 
 # 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 = {
-    'fixed_sidebar': 'true',
-    'sidebar_width': '200px',
-    'page_width': '95%',
-    'show_powered_by': 'false',
-    'logo_name': 'true',
-}
+#html_theme_options = {}
+
+def setup(app):
+    app.add_stylesheet('css/my_theme.css')
 
 # 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']
 
+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()]
+
 # Custom sidebar templates, maps document names to template names.
-html_sidebars = { '**': ['navigation.html', 'relations.html', 'searchbox.html'] }
-html_last_updated_fmt = None
+#html_sidebars = { '**': ['navigation.html', 'relations.html', 'searchbox.html'] }
+#html_last_updated_fmt = None
 
 # -- Options for HTMLHelp output ------------------------------------------
 

doc/source/index.rst

-.. GstLAL documentation master file, created by
-   sphinx-quickstart on Wed Apr 25 21:10:13 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-The GstLAL project documentation
+GstLAL documentation
 ================================
 
 `GstLAL` provides a suite of GStreamer elements that expose gravitational-wave data analysis tools from the LALSuite library for use in GStreamer signal-processing pipelines.
 
 Examples include an element to add simulated gravitational waves to an h(t) stream, and a source element to provide the contents of .gwf frame files to a GStreamer pipeline.
 
+Overview
+-------------------------
+
+The GstLAL software package is used for the following activities:
+
+- **GstLAL:** The package `GstLAL <http://software.ligo.org/lscsoft/source/gstlal-1.4.1.tar.gz>`_ provides core Gstreamer plugins for signal processing workflows with LIGO data and core python bindings for constructing such workflows.  
+
+- **GstLAL Calibration:** The package `GstLAL Calibration <http://software.ligo.org/lscsoft/source/gstlal-calibration-1.2.4.tar.gz>`_ provides real-time calibration of LIGO control system data into strain data.
+
+- **GstLAL Inspiral:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ provides additional signal processing plugins that are specific for LIGO / Virgo searches for compact binaries as well as a substantial amount of python code for post-processing raw signal processing results into gravitational wave candidate lists. Several publications about the methodology and workflow exist, see :ref:`publications`
+
+- **GstLAL Ugly:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ is an incubator project for gradual inclusion in the other packages.
+
+
 .. _welcome-contents:
 
 Contents
@@ -18,11 +27,18 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   overview
    getting-started
    projects
    publications
 
+Build/Test Results
+-------------------------
+
+Results pages for the `Offline Tutorial Test <https://git.ligo.org/lscsoft/gstlal/blob/master/gstlal-inspiral/tests/Makefile.offline_tutorial_test>`_ are generated automatically and are located here:
+
+* `gstlal_offline_tutorial test dag <gstlal_offline_tutorial/1000000000-1000002048-test_dag-run_1/>`_
+* `gstlal_offline_tutorial test dag lite <gstlal_offline_tutorial/1000000000-1000002048-test_dag-run_1_lite/>`_
+
 .. _welcome-indices:
 
 Indices and tables
@@ -32,10 +48,3 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-Build/Test Results
--------------------------
-
-Results pages for the `Offline Tutorial Test <https://git.ligo.org/lscsoft/gstlal/blob/master/gstlal-inspiral/tests/Makefile.offline_tutorial_test>`_ are generated automatically and are located here:
-
-* `gstlal_offline_tutorial test dag <gstlal_offline_tutorial/1000000000-1000002048-test_dag-run_1/>`_
-* `gstlal_offline_tutorial test dag lite <gstlal_offline_tutorial/1000000000-1000002048-test_dag-run_1_lite/>`_

doc/source/overview.rst

-Overview
-========
-
-The GstLAL software package is used for the following activities:
-
-- **GstLAL:** The package `GstLAL <http://software.ligo.org/lscsoft/source/gstlal-1.4.1.tar.gz>`_ provides core Gstreamer plugins for signal processing workflows with LIGO data and core python bindings for constructing such workflows.  
-
-- **GstLAL Calibration:** The package `GstLAL Calibration <http://software.ligo.org/lscsoft/source/gstlal-calibration-1.2.4.tar.gz>`_ provides real-time calibration of LIGO control system data into strain data.
-
-- **GstLAL Inspiral:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ provides additional signal processing plugins that are specific for LIGO / Virgo searches for compact binaries as well as a substantial amount of python code for post-processing raw signal processing results into gravitational wave candidate lists. Several publications about the methodology and workflow exist, see :ref:`publications`
-
-- **GstLAL Ugly:** The package `GstLAL Inspiral <http://software.ligo.org/lscsoft/source/gstlal-inspiral-1.5.1.tar.gz>`_ is an incubator project for gradual inclusion in the other packages.
-
-