From abb025a4aec14e165a3265251a4d66fd5f92b652 Mon Sep 17 00:00:00 2001
From: Patrick Godwin <patrick.godwin@ligo.org>
Date: Mon, 15 Jul 2019 14:16:50 -0700
Subject: [PATCH] reorganize docs so information is easier to find
---
doc/Makefile | 14 ++++++-
doc/source/api.rst | 12 ++++++
doc/source/cbc_analysis.rst | 6 +++
doc/source/executables.rst | 11 ++++++
doc/source/fake_data.rst | 6 +++
.../overview.rst => feature_extraction.rst} | 6 +--
doc/source/gstlal-burst/code.rst | 8 ----
doc/source/gstlal-burst/gstlal-burst.rst | 19 ----------
.../gstlal-burst/tutorials/tutorials.rst | 9 -----
doc/source/gstlal-calibration/code.rst | 8 ----
.../gstlal-calibration/gstlal-calibration.rst | 7 ----
doc/source/gstlal-calibration/overview.rst | 4 --
doc/source/gstlal-inspiral/code.rst | 8 ----
.../gstlal-inspiral/gstlal-inspiral.rst | 8 ----
doc/source/gstlal-inspiral/overview.rst | 4 --
doc/source/gstlal-ugly/code.rst | 8 ----
doc/source/gstlal-ugly/gstlal-ugly.rst | 7 ----
doc/source/gstlal-ugly/overview.rst | 4 --
doc/source/gstlal/code.rst | 8 ----
doc/source/gstlal/gstlal.rst | 9 -----
doc/source/gstlal/overview.rst | 4 --
doc/source/gstlal/tutorials/tutorials.rst | 7 ----
doc/source/index.rst | 37 +++++++++++++------
.../{getting-started.rst => installation.rst} | 2 +-
doc/source/projects.rst | 14 -------
doc/source/psd_estimation.rst | 6 +++
doc/source/publications.rst | 1 +
doc/source/quickstart.rst | 6 +++
.../tutorials/gstlal_fake_data_overview.rst | 4 +-
.../tutorials/offline_analysis.rst | 2 +-
.../offline_fx_jobs.rst} | 3 +-
.../tutorials/online_analysis.rst | 2 +-
.../online_fx_jobs.rst} | 3 +-
.../tutorials/tutorials.rst | 3 ++
doc/sphinx-bindoc | 2 +-
35 files changed, 98 insertions(+), 164 deletions(-)
create mode 100644 doc/source/api.rst
create mode 100644 doc/source/cbc_analysis.rst
create mode 100644 doc/source/executables.rst
create mode 100644 doc/source/fake_data.rst
rename doc/source/{gstlal-burst/overview.rst => feature_extraction.rst} (96%)
delete mode 100644 doc/source/gstlal-burst/code.rst
delete mode 100644 doc/source/gstlal-burst/gstlal-burst.rst
delete mode 100644 doc/source/gstlal-burst/tutorials/tutorials.rst
delete mode 100644 doc/source/gstlal-calibration/code.rst
delete mode 100644 doc/source/gstlal-calibration/gstlal-calibration.rst
delete mode 100644 doc/source/gstlal-calibration/overview.rst
delete mode 100644 doc/source/gstlal-inspiral/code.rst
delete mode 100644 doc/source/gstlal-inspiral/gstlal-inspiral.rst
delete mode 100644 doc/source/gstlal-inspiral/overview.rst
delete mode 100644 doc/source/gstlal-ugly/code.rst
delete mode 100644 doc/source/gstlal-ugly/gstlal-ugly.rst
delete mode 100644 doc/source/gstlal-ugly/overview.rst
delete mode 100644 doc/source/gstlal/code.rst
delete mode 100644 doc/source/gstlal/gstlal.rst
delete mode 100644 doc/source/gstlal/overview.rst
delete mode 100644 doc/source/gstlal/tutorials/tutorials.rst
rename doc/source/{getting-started.rst => installation.rst} (99%)
delete mode 100644 doc/source/projects.rst
create mode 100644 doc/source/psd_estimation.rst
create mode 100644 doc/source/quickstart.rst
rename doc/source/{gstlal => }/tutorials/gstlal_fake_data_overview.rst (97%)
rename doc/source/{gstlal-inspiral => }/tutorials/offline_analysis.rst (99%)
rename doc/source/{gstlal-burst/tutorials/running_offline_jobs.rst => tutorials/offline_fx_jobs.rst} (97%)
rename doc/source/{gstlal-inspiral => }/tutorials/online_analysis.rst (98%)
rename doc/source/{gstlal-burst/tutorials/running_online_jobs.rst => tutorials/online_fx_jobs.rst} (97%)
rename doc/source/{gstlal-inspiral => }/tutorials/tutorials.rst (57%)
diff --git a/doc/Makefile b/doc/Makefile
index 1469a64439..740750bd3b 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,35 +1,45 @@
gstlal-modules :
# FIXME FIXME FIXME total hack to work around unique python packaging
- #mv ../gstlal/python/__init__.py ../gstlal/python/__init__.py.bk
+ mv ../gstlal/python/__init__.py ../gstlal/python/__init__.py.bk
sphinx-apidoc -e -o source/gstlal/python-modules ../gstlal/python ../gstlal/python/misc.py ../gstlal/python/bottle.py ../gstlal/python/coherent_null.py ../gstlal/python/matplotlibhelper.py
- #mv ../gstlal/python/__init__.py.bk ../gstlal/python/__init__.py
+ mv ../gstlal/python/__init__.py.bk ../gstlal/python/__init__.py
+ sed -i "1s/python/\`\`gstlal\`\`/" source/gstlal/python-modules/modules.rst
gstlal-inspiral-modules :
sphinx-apidoc -e -o source/gstlal-inspiral/python-modules ../gstlal-inspiral/python ../gstlal-inspiral/python/cbc_template_iir.py ../gstlal-inspiral/python/spawaveform.py ../gstlal-inspiral/python/emcee.py ../gstlal-inspiral/python/spiirparts.py ../gstlal-inspiral/python/snglinspiraltable.py
+ sed -i "1s/python/\`\`gstlal-inspiral\`\`/" source/gstlal-inspiral/python-modules/modules.rst
gstlal-calibration-modules :
sphinx-apidoc -e -o source/gstlal-calibration/python-modules ../gstlal-calibration/python
+ sed -i "1s/python/\`\`gstlal-calibration\`\`/" source/gstlal-calibration/python-modules/modules.rst
gstlal-burst-modules :
sphinx-apidoc -e -o source/gstlal-burst/python-modules ../gstlal-burst/python ../gstlal-burst/python/excesspower ../gstlal-burst/python/fxtools/sngltriggertable.py
+ sed -i "1s/python/\`\`gstlal-burst\`\`/" source/gstlal-burst/python-modules/modules.rst
gstlal-ugly-modules :
sphinx-apidoc -e -o source/gstlal-ugly/python-modules ../gstlal-ugly/python ../gstlal-ugly/python/gviz_api.py ../gstlal-ugly/python/coherent_inspiral_metric.py ../gstlal-ugly/python/coherent_inspiral_metric_plots.py ../gstlal-ugly/python/coherent_inspiral_metric_detector_details.py ../gstlal-ugly/python/aggregator.py
+ sed -i "1s/python/\`\`gstlal-ugly\`\`/" source/gstlal-ugly/python-modules/modules.rst
gstlal-bin :
./sphinx-bindoc source/gstlal/bin ../gstlal/bin gstlal_ligo_data_find_check
+ sed -i "1s/bin/\`\`gstlal\`\`/" source/gstlal/bin/bin.rst
gstlal-inspiral-bin :
./sphinx-bindoc source/gstlal-inspiral/bin ../gstlal-inspiral/bin gstlal_inspiral_flopulator gstlal_inspiral_lvalert_omegascan gstlal_ll_inspiral_calculate_range gstlal_ll_inspiral_daily_page_online gstlal_iir_inspiral gstlal_inspiral_iir_bank_pipe gstlal_ll_inspiral_save_state gstlal_inspiral_marginalize_likelihoods_online gstlal_inspiral_plot_extrinsic_params gstlal_ll_inspiral_get_urls gstlal_inspiral_plot_svd_bank gstlal_inspiral_lvalert_background_plotter
+ sed -i "1s/bin/\`\`gstlal-inspiral\`\`/" source/gstlal-inspiral/bin/bin.rst
gstlal-calibration-bin :
./sphinx-bindoc source/gstlal-calibration/bin ../gstlal-calibration/bin
+ sed -i "1s/bin/\`\`gstlal-calibration\`\`/" source/gstlal-calibration/bin/bin.rst
gstlal-burst-bin :
./sphinx-bindoc source/gstlal-burst/bin ../gstlal-burst/bin gstlal_excesspower gstlal_excesspower_trigvis
+ sed -i "1s/bin/\`\`gstlal-burst\`\`/" source/gstlal-burst/bin/bin.rst
gstlal-ugly-bin :
./sphinx-bindoc source/gstlal-ugly/bin ../gstlal-ugly/bin gstlal_h1h2_coh_frames gstlal_geo_player gstlal_ll_inspiral_daily_summary_page gstlal_cache_to_segments gstlal_inspiral_plot_efficiency gstlal_burst_injections_by_rate_plot gstlal_display_from_logs gstlal_inspiral_bankviz gstlal_ll_inspiral_regen_reg_from_condor_q gstlal_cbc_sensitivity_vs_flow_at_fixed_computational_cost gstlal_inspiral_check_livetimes gstlal_rds_gen gstlal_injections_by_local_rate_plot gstlal_ninja_smooth_reference_psd gstlal_shift_frames
+ sed -i "1s/bin/\`\`gstlal-ugly\`\`/" source/gstlal-ugly/bin/bin.rst
html : gstlal-modules gstlal-inspiral-modules gstlal-calibration-modules gstlal-ugly-modules gstlal-burst-modules gstlal-bin gstlal-inspiral-bin gstlal-calibration-bin gstlal-ugly-bin gstlal-burst-bin
sphinx-build -b html source _build
diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 0000000000..219b4f1f18
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,12 @@
+GstLAL API
+============
+
+.. toctree::
+ :maxdepth: 2
+ :glob:
+
+ gstlal/python-modules/*modules
+ gstlal-inspiral/python-modules/*modules
+ gstlal-calibration/python-modules/*modules
+ gstlal-burst/python-modules/*modules
+ gstlal-ugly/python-modules/*modules
diff --git a/doc/source/cbc_analysis.rst b/doc/source/cbc_analysis.rst
new file mode 100644
index 0000000000..0396d5c63f
--- /dev/null
+++ b/doc/source/cbc_analysis.rst
@@ -0,0 +1,6 @@
+.. _cbc-analysis:
+
+CBC Analysis
+================
+
+WRITEME
diff --git a/doc/source/executables.rst b/doc/source/executables.rst
new file mode 100644
index 0000000000..6e83048340
--- /dev/null
+++ b/doc/source/executables.rst
@@ -0,0 +1,11 @@
+Executables
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+ gstlal/bin/bin
+ gstlal-inspiral/bin/bin
+ gstlal-calibration/bin/bin
+ gstlal-burst/bin/bin
+ gstlal-ugly/bin/bin
diff --git a/doc/source/fake_data.rst b/doc/source/fake_data.rst
new file mode 100644
index 0000000000..a72cf95cf0
--- /dev/null
+++ b/doc/source/fake_data.rst
@@ -0,0 +1,6 @@
+.. _fake-data:
+
+Fake Data Generation
+=========================
+
+WRITEME
diff --git a/doc/source/gstlal-burst/overview.rst b/doc/source/feature_extraction.rst
similarity index 96%
rename from doc/source/gstlal-burst/overview.rst
rename to doc/source/feature_extraction.rst
index 75edba598c..c6faaea4d0 100644
--- a/doc/source/gstlal-burst/overview.rst
+++ b/doc/source/feature_extraction.rst
@@ -1,8 +1,4 @@
-####################################################################################################
-Overview
-####################################################################################################
-
-.. _burst-overview-feature_extraction:
+.. _feature_extraction:
Feature Extraction
====================================================================================================
diff --git a/doc/source/gstlal-burst/code.rst b/doc/source/gstlal-burst/code.rst
deleted file mode 100644
index ec07ab55c2..0000000000
--- a/doc/source/gstlal-burst/code.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL burst code
-=================
-
-.. toctree::
- :maxdepth: 2
-
- bin/bin
- python-modules/modules
diff --git a/doc/source/gstlal-burst/gstlal-burst.rst b/doc/source/gstlal-burst/gstlal-burst.rst
deleted file mode 100644
index 04d379007b..0000000000
--- a/doc/source/gstlal-burst/gstlal-burst.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-####################################################################################################
-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/tutorials/tutorials.rst b/doc/source/gstlal-burst/tutorials/tutorials.rst
deleted file mode 100644
index 34d6b699ee..0000000000
--- a/doc/source/gstlal-burst/tutorials/tutorials.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-####################################################################################################
-Tutorials
-####################################################################################################
-
-.. toctree::
- :maxdepth: 2
-
- running_online_jobs
- running_offline_jobs
diff --git a/doc/source/gstlal-calibration/code.rst b/doc/source/gstlal-calibration/code.rst
deleted file mode 100644
index 32af084463..0000000000
--- a/doc/source/gstlal-calibration/code.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL calibration code
-=======================
-
-.. toctree::
- :maxdepth: 2
-
- bin/bin
- python-modules/modules
diff --git a/doc/source/gstlal-calibration/gstlal-calibration.rst b/doc/source/gstlal-calibration/gstlal-calibration.rst
deleted file mode 100644
index c0c574f222..0000000000
--- a/doc/source/gstlal-calibration/gstlal-calibration.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-GstLAL calibration
-==========================
-
-.. toctree::
- :maxdepth: 2
-
- code
diff --git a/doc/source/gstlal-calibration/overview.rst b/doc/source/gstlal-calibration/overview.rst
deleted file mode 100644
index d1140b8eb4..0000000000
--- a/doc/source/gstlal-calibration/overview.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Overview
-========
-
-FIXME
diff --git a/doc/source/gstlal-inspiral/code.rst b/doc/source/gstlal-inspiral/code.rst
deleted file mode 100644
index 5796dbaece..0000000000
--- a/doc/source/gstlal-inspiral/code.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL inspiral code
-====================
-
-.. toctree::
- :maxdepth: 2
-
- bin/bin
- python-modules/modules
diff --git a/doc/source/gstlal-inspiral/gstlal-inspiral.rst b/doc/source/gstlal-inspiral/gstlal-inspiral.rst
deleted file mode 100644
index f9994043cd..0000000000
--- a/doc/source/gstlal-inspiral/gstlal-inspiral.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL inspiral
-=======================
-
-.. toctree::
- :maxdepth: 2
-
- tutorials/tutorials
- code
diff --git a/doc/source/gstlal-inspiral/overview.rst b/doc/source/gstlal-inspiral/overview.rst
deleted file mode 100644
index d1140b8eb4..0000000000
--- a/doc/source/gstlal-inspiral/overview.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Overview
-========
-
-FIXME
diff --git a/doc/source/gstlal-ugly/code.rst b/doc/source/gstlal-ugly/code.rst
deleted file mode 100644
index 3aba8eab04..0000000000
--- a/doc/source/gstlal-ugly/code.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL ugly code
-================
-
-.. toctree::
- :maxdepth: 2
-
- bin/bin
- python-modules/modules
diff --git a/doc/source/gstlal-ugly/gstlal-ugly.rst b/doc/source/gstlal-ugly/gstlal-ugly.rst
deleted file mode 100644
index b7807cd11f..0000000000
--- a/doc/source/gstlal-ugly/gstlal-ugly.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-GstLAL ugly
-===================
-
-.. toctree::
- :maxdepth: 2
-
- code
diff --git a/doc/source/gstlal-ugly/overview.rst b/doc/source/gstlal-ugly/overview.rst
deleted file mode 100644
index d1140b8eb4..0000000000
--- a/doc/source/gstlal-ugly/overview.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Overview
-========
-
-FIXME
diff --git a/doc/source/gstlal/code.rst b/doc/source/gstlal/code.rst
deleted file mode 100644
index deebd9f805..0000000000
--- a/doc/source/gstlal/code.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-GstLAL Code
-===========
-
-.. toctree::
- :maxdepth: 2
-
- bin/bin
- python-modules/modules
diff --git a/doc/source/gstlal/gstlal.rst b/doc/source/gstlal/gstlal.rst
deleted file mode 100644
index ceadb68af3..0000000000
--- a/doc/source/gstlal/gstlal.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-GstLAL
-==============
-
-.. toctree::
- :maxdepth: 2
-
- tutorials/tutorials
- code
-
diff --git a/doc/source/gstlal/overview.rst b/doc/source/gstlal/overview.rst
deleted file mode 100644
index d1140b8eb4..0000000000
--- a/doc/source/gstlal/overview.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-Overview
-========
-
-FIXME
diff --git a/doc/source/gstlal/tutorials/tutorials.rst b/doc/source/gstlal/tutorials/tutorials.rst
deleted file mode 100644
index 028fb59f48..0000000000
--- a/doc/source/gstlal/tutorials/tutorials.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Tutorials
-=========
-
-.. toctree::
- :maxdepth: 1
-
- gstlal_fake_data_overview
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3b9bf255eb..c46db0e1e3 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,26 +10,41 @@ 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`` 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-calibration`` 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-inspiral`` 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.
+- ``gstlal-burst`` provides additional signal processing plugins for use in astrophysical and noise transient burst searches.
+- ``gstlal-ugly`` is an incubator project for gradual inclusion in the other packages.
-.. _welcome-contents:
-Contents
--------------------------
+.. toctree::
+ :caption: Getting Started
+ :maxdepth: 2
+
+ installation
+ quickstart
+ tutorials/tutorials
+
+.. toctree::
+ :caption: User Guide
+ :maxdepth: 2
+
+ cbc_analysis
+ feature_extraction
+ fake_data
+ psd_estimation
+ publications
.. toctree::
- :maxdepth: 2
+ :caption: API Reference
+ :maxdepth: 2
- getting-started
- projects
- publications
+ executables
+ api
Build/Test Results
-------------------------
diff --git a/doc/source/getting-started.rst b/doc/source/installation.rst
similarity index 99%
rename from doc/source/getting-started.rst
rename to doc/source/installation.rst
index 37cf8377b4..da57ce3c6e 100644
--- a/doc/source/getting-started.rst
+++ b/doc/source/installation.rst
@@ -1,4 +1,4 @@
-Getting started
+Installation
===============
You can get a development copy of the gstlal software suite from git. Doing this at minimum will require a development copy of lalsuite.
diff --git a/doc/source/projects.rst b/doc/source/projects.rst
deleted file mode 100644
index 0191dd33e7..0000000000
--- a/doc/source/projects.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Projects
-========
-
-.. toctree::
- :maxdepth: 1
-
- gstlal/gstlal
- gstlal-inspiral/gstlal-inspiral
- gstlal-calibration/gstlal-calibration
- gstlal-burst/gstlal-burst
- gstlal-ugly/gstlal-ugly
-
-
-
diff --git a/doc/source/psd_estimation.rst b/doc/source/psd_estimation.rst
new file mode 100644
index 0000000000..feea6886f2
--- /dev/null
+++ b/doc/source/psd_estimation.rst
@@ -0,0 +1,6 @@
+.. _psd-generation:
+
+PSD Generation
+================
+
+WRITEME
diff --git a/doc/source/publications.rst b/doc/source/publications.rst
index 4303cd5115..2000bae534 100644
--- a/doc/source/publications.rst
+++ b/doc/source/publications.rst
@@ -1,4 +1,5 @@
.. _publications:
+
Publications
============
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
new file mode 100644
index 0000000000..30ece5bf82
--- /dev/null
+++ b/doc/source/quickstart.rst
@@ -0,0 +1,6 @@
+.. _quickstart:
+
+Quickstart
+============
+
+WRITEME
diff --git a/doc/source/gstlal/tutorials/gstlal_fake_data_overview.rst b/doc/source/tutorials/gstlal_fake_data_overview.rst
similarity index 97%
rename from doc/source/gstlal/tutorials/gstlal_fake_data_overview.rst
rename to doc/source/tutorials/gstlal_fake_data_overview.rst
index 04f0aaa951..96ecad7a47 100644
--- a/doc/source/gstlal/tutorials/gstlal_fake_data_overview.rst
+++ b/doc/source/tutorials/gstlal_fake_data_overview.rst
@@ -23,7 +23,7 @@ The basic steps to generate and validate LIGO colored noise are:
An example PSD plot:
-.. image:: ../images/H1L1fakedataexamplepsd.png
+.. image:: ../gstlal/images/H1L1fakedataexamplepsd.png
:width: 400px
Custom colored noise, i.e. simulate your own detector
@@ -40,7 +40,7 @@ then you will need to first use gstlal_psd_xml_from_asd_txt to convert it
in the documentation include this)
1. Repeat the same validation steps as above to obtain, e.g.:
-.. image:: ../images/V1fakedataexamplepsd.png
+.. image:: ../gstlal/images/V1fakedataexamplepsd.png
:width: 400px
diff --git a/doc/source/gstlal-inspiral/tutorials/offline_analysis.rst b/doc/source/tutorials/offline_analysis.rst
similarity index 99%
rename from doc/source/gstlal-inspiral/tutorials/offline_analysis.rst
rename to doc/source/tutorials/offline_analysis.rst
index 018606e8be..7f62fcfcc0 100644
--- a/doc/source/gstlal-inspiral/tutorials/offline_analysis.rst
+++ b/doc/source/tutorials/offline_analysis.rst
@@ -1,4 +1,4 @@
-Documentation for running an offline compact binary coalescence analysis
+Running an offline compact binary coalescence analysis
========================================================================
Prerequisites
diff --git a/doc/source/gstlal-burst/tutorials/running_offline_jobs.rst b/doc/source/tutorials/offline_fx_jobs.rst
similarity index 97%
rename from doc/source/gstlal-burst/tutorials/running_offline_jobs.rst
rename to doc/source/tutorials/offline_fx_jobs.rst
index d673346786..dbee90fe23 100644
--- a/doc/source/gstlal-burst/tutorials/running_offline_jobs.rst
+++ b/doc/source/tutorials/offline_fx_jobs.rst
@@ -1,5 +1,4 @@
-####################################################################################################
-Running Offline Jobs
+Running offline feature extraction jobs
####################################################################################################
An offline DAG is provided in /gstlal-burst/share/feature_extractor/Makefile.gstlal_feature_extractor_offline
diff --git a/doc/source/gstlal-inspiral/tutorials/online_analysis.rst b/doc/source/tutorials/online_analysis.rst
similarity index 98%
rename from doc/source/gstlal-inspiral/tutorials/online_analysis.rst
rename to doc/source/tutorials/online_analysis.rst
index edbe453d57..5f43369d0c 100644
--- a/doc/source/gstlal-inspiral/tutorials/online_analysis.rst
+++ b/doc/source/tutorials/online_analysis.rst
@@ -1,4 +1,4 @@
-Documentation for starting an online compact binary coalescence analysis
+Running an online compact binary coalescence analysis
========================================================================
Prerequisites
diff --git a/doc/source/gstlal-burst/tutorials/running_online_jobs.rst b/doc/source/tutorials/online_fx_jobs.rst
similarity index 97%
rename from doc/source/gstlal-burst/tutorials/running_online_jobs.rst
rename to doc/source/tutorials/online_fx_jobs.rst
index 41bcc642ef..0c86c93d93 100644
--- a/doc/source/gstlal-burst/tutorials/running_online_jobs.rst
+++ b/doc/source/tutorials/online_fx_jobs.rst
@@ -1,5 +1,4 @@
-####################################################################################################
-Running Online Jobs
+Running online feature extraction jobs
####################################################################################################
An online DAG is provided in /gstlal-burst/share/feature_extractor/Makefile.gstlal_feature_extractor_online
diff --git a/doc/source/gstlal-inspiral/tutorials/tutorials.rst b/doc/source/tutorials/tutorials.rst
similarity index 57%
rename from doc/source/gstlal-inspiral/tutorials/tutorials.rst
rename to doc/source/tutorials/tutorials.rst
index f1198230ae..48996d7951 100644
--- a/doc/source/gstlal-inspiral/tutorials/tutorials.rst
+++ b/doc/source/tutorials/tutorials.rst
@@ -4,5 +4,8 @@ Tutorials
.. toctree::
:maxdepth: 1
+ gstlal_fake_data_overview
online_analysis
offline_analysis
+ online_fx_jobs
+ offline_fx_jobs
diff --git a/doc/sphinx-bindoc b/doc/sphinx-bindoc
index 8d537747c2..44938b93a3 100755
--- a/doc/sphinx-bindoc
+++ b/doc/sphinx-bindoc
@@ -23,7 +23,7 @@ outdir = sys.argv[1]
tocf = open(os.path.join(outdir, "bin.rst"), "w")
tocf.write("""bin
-===
+=====================
.. toctree::
:maxdepth: 1
--
GitLab