Reports template

Overview

When you create notebooks like this one, you can use sphinx to render them as html. The output supports both static matplotlib style plots and interactive plotly style plots.

Instructions

First, create notebooks in the reports directory.

Next, modify the file index.rst, also in the reports directory.

Here’s an example.

.. Template documentation master file, created by
   sphinx-quickstart
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to your_project's documentation!
========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   reports_template


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Notice the line reports_template in the example above. This is just the name of this notebook minus it’s .ipynb extension.

To add additional notebooks, put their name (minus the .ipynb extension) on the next line.

To build the html, from you computer (outside docker), run ./build_html in the project root directory, or from a shell inside the container, go to the /srv/reports directory and run make html.