diff --git a/doc/source/conf.py b/doc/source/conf.py index 835a68644fb2b60079bba752d651ecb41208e534..27a832c865631c44735a2ec11c0524157576f95d 100644 --- a/doc/source/conf.py +++ b/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 ------------------------------------------ diff --git a/doc/source/gstlal-burst/gstlal-burst.rst b/doc/source/gstlal-burst/gstlal-burst.rst index a46a0af4a3ddc6bfeeb81296acc4a8619e2a8536..04d379007b1332818bb1c66c2184dfe7ad5763f6 100644 --- a/doc/source/gstlal-burst/gstlal-burst.rst +++ b/doc/source/gstlal-burst/gstlal-burst.rst @@ -1,8 +1,19 @@ -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 diff --git a/doc/source/gstlal-burst/overview.rst b/doc/source/gstlal-burst/overview.rst index d1140b8eb49d431e1ed6fdfc3530c85e13c15dfc..157b681bee3dfe6a643792c76e1b8907ae1a27c1 100644 --- a/doc/source/gstlal-burst/overview.rst +++ b/doc/source/gstlal-burst/overview.rst @@ -1,4 +1,11 @@ +#################################################################################################### Overview -======== +#################################################################################################### -FIXME +.. _burst-overview-feature_extraction: + +Feature Extraction +==================================================================================================== + +The `fxtools` module contains relevant libraries to identify glitches in low-latency using auxiliary +channel data. diff --git a/doc/source/gstlal-burst/tutorials/running_offline_jobs.rst b/doc/source/gstlal-burst/tutorials/running_offline_jobs.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc25a5af2e06f835f2f34bd1b155f8b6aa680a2f --- /dev/null +++ b/doc/source/gstlal-burst/tutorials/running_offline_jobs.rst @@ -0,0 +1,5 @@ +#################################################################################################### +Running Offline Jobs +#################################################################################################### + +TODO diff --git a/doc/source/gstlal-burst/tutorials/running_online_jobs.rst b/doc/source/gstlal-burst/tutorials/running_online_jobs.rst new file mode 100644 index 0000000000000000000000000000000000000000..f9db3da181a35619246b152f290f5759c4cac5dd --- /dev/null +++ b/doc/source/gstlal-burst/tutorials/running_online_jobs.rst @@ -0,0 +1,5 @@ +#################################################################################################### +Running Online Jobs +#################################################################################################### + +TODO diff --git a/doc/source/gstlal-burst/tutorials/tutorials.rst b/doc/source/gstlal-burst/tutorials/tutorials.rst new file mode 100644 index 0000000000000000000000000000000000000000..34d6b699eeab41abde1b5a0cba55d6c414c93717 --- /dev/null +++ b/doc/source/gstlal-burst/tutorials/tutorials.rst @@ -0,0 +1,9 @@ +#################################################################################################### +Tutorials +#################################################################################################### + +.. toctree:: + :maxdepth: 2 + + running_online_jobs + running_offline_jobs diff --git a/doc/source/gstlal-calibration/gstlal-calibration.rst b/doc/source/gstlal-calibration/gstlal-calibration.rst index 5946e59bc7e0bb1c4565564e07c9071440247a27..9db3409b1abfdc01a69dc7169b4311c8400f12bc 100644 --- a/doc/source/gstlal-calibration/gstlal-calibration.rst +++ b/doc/source/gstlal-calibration/gstlal-calibration.rst @@ -1,4 +1,4 @@ -GstLAL calibration project +GstLAL calibration ========================== .. toctree:: diff --git a/doc/source/gstlal-inspiral/gstlal-inspiral.rst b/doc/source/gstlal-inspiral/gstlal-inspiral.rst index ac4c6a886ae1145d95ab222d327ee1899c225a2d..9b1fc567b762af84ac6f2429430db08264f42215 100644 --- a/doc/source/gstlal-inspiral/gstlal-inspiral.rst +++ b/doc/source/gstlal-inspiral/gstlal-inspiral.rst @@ -1,4 +1,4 @@ -GstLAL inspiral project +GstLAL inspiral ======================= .. toctree:: diff --git a/doc/source/gstlal-ugly/gstlal-ugly.rst b/doc/source/gstlal-ugly/gstlal-ugly.rst index 992f02f7e897a6796e7f1a3d0ea21d515d3ddecf..d7317563db3afc9c0f37a484dea7fb250192d463 100644 --- a/doc/source/gstlal-ugly/gstlal-ugly.rst +++ b/doc/source/gstlal-ugly/gstlal-ugly.rst @@ -1,4 +1,4 @@ -GstLAL ugly project +GstLAL ugly =================== .. toctree:: diff --git a/doc/source/gstlal/gstlal.rst b/doc/source/gstlal/gstlal.rst index 21e932c4de289d47dc1c34e695948448758fdd0e..06ad854d024178d52e42f6ed4b564ca682834acf 100644 --- a/doc/source/gstlal/gstlal.rst +++ b/doc/source/gstlal/gstlal.rst @@ -1,4 +1,4 @@ -GstLAL project +GstLAL ============== .. toctree::