Rtd integration of notebooks

[fsenf]

I explore read-the-docs integration of our examples. I chose sphinx-gallery, see https://docs.readthedocs.io/en/stable/guides/jupyter.html#creating-galleries-of-examples-using-notebooks

This dev is branched off https://github.com/fsenf/tobac/tree/backintegration_of_tutorials and thus need to wait for #334 being back-integrated.

This fixes #409

• Have you followed our guidelines in CONTRIBUTING.md?
• Have you self-reviewed your code and corrected any misspellings?
• Have you written documentation that is easy to understand?
• Have you written descriptive commit messages?
• Have you added NumPy docstrings for newly added functions?
• Have you formatted your code using black?
• If you have introduced a new functionality, have you added adequate unit tests?
• Have all tests passed in your local clone?
• If you have introduced a new functionality, have you added an example notebook?
• Have you kept your pull request small and limited so that it is easy to review?
• Have the newest changes from this branch been merged?

[github-actions]

Linting results by Pylint:

Your code has been rated at 8.72/10 (previous run: 8.72/10, +0.00)
_{The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.5.x branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.}

[w-k-jones]

This looks really nice! I can review after #334 is merged

[fsenf]

Here is this direct link to the rendered gallery for your convenience: https://tobac--411.org.readthedocs.build/en/411/examples.html

... there is room for improvement ... let's hope that some skilled people come around in future ;-)

[freemansw1]

@fsenf this is beautiful and a preeminent example of what our documentation should be. Let's get this in ASAP after #334 is in.

[JuliaKukulies]

Wow, very nice @fsenf ! Are you going to do the second review @freemansw1 ? If not, I can also review after #334

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 57.00%. Comparing base (cb44192) to head (df86e7f).

Additional details and impacted files

@@            Coverage Diff             @@
##           RC_v1.5.x     #411   +/-   ##
==========================================
  Coverage      57.00%   57.00%           
==========================================
  Files             20       20           
  Lines           3454     3454           
==========================================
  Hits            1969     1969           
  Misses          1485     1485           

Flag	Coverage Δ
unittests	57.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fsenf]

OK, #334 is done!

I updated this PR accordingly to hold also the newest changes of https://github.com/tobac-project/tobac/tree/RC_v1.5.x

@w-k-jones & @JuliaKukulies : It is ready for review now. Thank you for your willingness to review the PR!

[w-k-jones]

This looks really good! My only suggestions are regarding the naming of different sections, but I'll leave it open to your judgement whether you like these changes or not

[fsenf]

HI @JuliaKukulies , what is your opinion on this contribution?

[JuliaKukulies]

This looks great - excellent contribution @fsenf! Just a tiny syntax correction after your headlines update. Otherwise, the PR is ready to be merged.

[fsenf]

great! Thank you for your superfast feedback! I will merge it after testing is finished.