DOCUMENTATION.md

• The generation of recipes using Sphinx-Gallery requires:

  sphinx==2.4.5
  sphinx-gallery==0.11.0
  sphinx-copybutton==0.5.1
  sphinx-toggleprompt==0.2.0
  sphinxcontrib-spelling==4.3.0
  

• The .py files to generate recipes are stored in docs/source/recipes/.

• For every new added recipe, docs/source/recipes/recipe_list.txt has to be edited to include the newly added recipe with its corresponding filters in the standardised manner as given for the previous recipes:

  plot_1_recipe.html#sphx-glr-recipes-plot-1-recipe-py
  <div class="sphx-glr-thumbcontainer collapse lineplot" tooltip="Collapse, Lineplot">
  plot_2_recipe.html#sphx-glr-recipes-plot-2-recipe-py
  <div class="sphx-glr-thumbcontainer collapse lineplot subspace" tooltip="Collapse, Lineplot, Subspace">
  plot_3_recipe.html#sphx-glr-recipes-plot-3-recipe-py
  <div class="sphx-glr-thumbcontainer collapse contourmap" tooltip="Collapse, Contourmap">
  ...
  plot_n_recipe.html#sphx-glr-recipes-plot-n-recipe-py
  <div class="sphx-glr-thumbcontainer collapse test" tooltip="Collapse, Test">

• If the filter doesn't exist, it has to be added in <div class="filter-menu"> alphabetically for /docs/source/recipes/README.rst, e.g.,

  <div class="filter-menu">
      <button data-filter="all">All</button>
      <button data-filter="aggregate">Aggregate</button>
      <button data-filter="collapse">Collapse</button>
      <button data-filter="contourmap">Contourmap</button>
      <button data-filter="lineplot">Lineplot</button>
      <button data-filter="regrid">Regrid</button>
      <button data-filter="subspace">Subspace</button>
      <button data-filter="testfilter">Test</button>
  </div>