Add examples page to docs

README.rst

@@ -15,39 +15,6 @@ help in creating a merge request, see `this page
 <https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html>`__ or contact
 us directly.
 
-Examples
---------
-
-To get started with ``tupak``, we have a few examples and tutorials:
-
-1. `Examples of injecting and recovering
-   data <https://git.ligo.org/Monash/tupak/tree/master/examples/injection_examples>`__
-
-   -  `A basic
-      tutorial <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/basic_tutorial.py>`__
-   -  `Create your own source
-      model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_source_model.py>`__
-   -  `Create your own time-domain source
-      model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_time_domain_source_model.py>`__
-   -  `How to specify the
-      prior <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/how_to_specify_the_prior.py>`__
-   -  `Using a partially marginalized
-      likelihood <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/marginalized_likelihood.py>`__
-
-2. `Examples using open
-   data <https://git.ligo.org/Monash/tupak/tree/master/examples/open_data_examples>`__
-
-   -  `Analysing the first Binary Black hole detection,
-      GW150914 <https://git.ligo.org/Monash/tupak/blob/master/examples/open_data_examples/GW150914.py>`__
-
-3. `Notebook-style
-   tutorials <https://git.ligo.org/Monash/tupak/tree/master/examples/tutorials>`__
-
-   -  `Comparing different
-      samplers <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/compare_samplers.ipynb>`__
-   -  `Visualising the
-      output <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/visualising_the_results.ipynb>`__
-
 .. |pipeline status| image:: https://git.ligo.org/Monash/tupak/badges/master/pipeline.svg
    :target: https://git.ligo.org/Monash/tupak/commits/master
 .. |coverage report| image:: https://monash.docs.ligo.org/tupak/coverage_badge.svg

docs/examples.txt

+========
+Examples
+========
+
+1. `General inference examples <https://git.ligo.org/Monash/tupak/tree/master/examples/other_examples>`_
+
+   - `A simple Gaussian likelihood <https://git.ligo.org/Monash/tupak/blob/master/examples/other_examples/gaussian_example.py>`_: a good example to see how to write your own likelihood.
+   - `Linear regression for unknown noise <https://git.ligo.org/Monash/tupak/blob/master/examples/other_examples/linear_regression_unknown_noise.py>`_: fitting to general time-domain data.
+
+2. `Examples of injecting and recovering
+   data <https://git.ligo.org/Monash/tupak/tree/master/examples/injection_examples>`__
+
+   -  `A basic
+      tutorial <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/basic_tutorial.py>`__
+   -  `Create your own source
+      model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_source_model.py>`__
+   -  `Create your own time-domain source
+      model <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/create_your_own_time_domain_source_model.py>`__
+   -  `How to specify the
+      prior <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/how_to_specify_the_prior.py>`__
+   -  `Using a partially marginalized
+      likelihood <https://git.ligo.org/Monash/tupak/blob/master/examples/injection_examples/marginalized_likelihood.py>`__
+
+3. `Examples using open
+   data <https://git.ligo.org/Monash/tupak/tree/master/examples/open_data_examples>`__
+
+   -  `Analysing the first Binary Black hole detection,
+      GW150914 <https://git.ligo.org/Monash/tupak/blob/master/examples/open_data_examples/GW150914.py>`__
+
+4. `Notebook-style
+   tutorials <https://git.ligo.org/Monash/tupak/tree/master/examples/tutorials>`__
+
+   -  `Comparing different
+      samplers <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/compare_samplers.ipynb>`__
+   -  `Visualising the
+      output <https://git.ligo.org/Monash/tupak/blob/master/examples/tutorials/visualising_the_results.ipynb>`__
+
+

docs/index.txt

@@ -9,6 +9,7 @@ Welcome to tupak's documentation!
    :caption: Contents:
 
    installation
+   examples
    basics-of-parameter-estimation
    prior
    likelihood