diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f6ea46ba2b8efd87b677acc334d991da3b33f390..1d57fbf660926878b412d7c88c703618ff2db3c6 100644 --- a/.gitlab-ci.yml +++ b/.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 diff --git a/doc/source/_static/css/my_theme.css b/doc/source/_static/css/my_theme.css new file mode 100644 index 0000000000000000000000000000000000000000..4b44b60e21a3e75f1275c20aacfd875c4c8b92f6 --- /dev/null +++ b/doc/source/_static/css/my_theme.css @@ -0,0 +1,30 @@ +/* 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; +} diff --git a/doc/source/gstlal.png b/doc/source/_static/gstlal.png similarity index 100% rename from doc/source/gstlal.png rename to doc/source/_static/gstlal.png diff --git a/doc/source/gstlal_small.png b/doc/source/_static/gstlal_small.png similarity index 100% rename from doc/source/gstlal_small.png rename to doc/source/_static/gstlal_small.png diff --git a/doc/source/_templates/layout.html b/doc/source/_templates/layout.html new file mode 100644 index 0000000000000000000000000000000000000000..5f5f043a3fb9d96449b627aa1406633dc8dabe7c --- /dev/null +++ b/doc/source/_templates/layout.html @@ -0,0 +1,2 @@ +{%- set logo = "gstlal.png" %} +{% extends "!layout.html" %} diff --git a/doc/source/conf.py b/doc/source/conf.py index ea4a5ebbe3d4c6ee46bbb48caca679615648920a..dd5d905c860cfc40a7da65c12edee68692708d5d 100644 --- a/doc/source/conf.py +++ b/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 ------------------------------------------ diff --git a/doc/source/index.rst b/doc/source/index.rst index 7aad0b7d37ea0196421c8b868b02817abd2abe92..3b9bf255eb66ca2296dc8359c3c99e7c60674e80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,15 +1,24 @@ -.. 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/>`_ diff --git a/doc/source/overview.rst b/doc/source/overview.rst deleted file mode 100644 index 280b4a451a13b59249bd516d0f60f7241d6d51c3..0000000000000000000000000000000000000000 --- a/doc/source/overview.rst +++ /dev/null @@ -1,14 +0,0 @@ -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. - -