Add toggle-buttons showing source scripts to cookbook (#4942)

Author: Meghan Jones

doc/rst/_extensions/sphinx_togglebutton/_static/togglebutton.css_t

@@ -64,7 +64,7 @@ button.toggle-button {
         content: "{{ togglebutton_hint }}";
         position: absolute;
         font-size: .8em;
-        left: -6.5em;
+        left: -13.5em;
         bottom: .4em;
     }
 }

doc/rst/conf.py.in

@@ -21,6 +21,7 @@ smartquotes_action = 'qe'
 highlight_language = 'bash'
 pygments_style = 'sphinx'
 autosectionlabel_prefix_document = True
+togglebutton_hint = "Click to show example script"
 
 # Disable sphinx_panels extension for manpage build
 if tags.has("nosphinxpanels"):

doc/rst/source/cookbook/colorspace.rst

@@ -234,6 +234,11 @@ terribly wrong when you do the interpolation in the other system.
    palette should be interpolated in HSV, since only hue should change between magenta (300) and red (0).
    Diamonds indicate which colors are defined in the palettes; they are fixed, the rest is interpolated.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_color_interpolate.txt
 
 Artificial illumination
 -----------------------
@@ -255,6 +260,12 @@ Artificial illumination
    vectors and normalizes the intensities to yield suitable shading; see :doc:`/grdgradient`
    for more details.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_slope2intensity.txt
+
 GMT uses the HSV system to achieve artificial illumination of colored
 images (e.g., **-I** option in :doc:`/grdimage`) by changing the saturation
 *s* and value *v* coordinates of the color. As explained above, when the *intensity* is zero
@@ -292,6 +303,12 @@ obvious in RGB.
    coordinates are given by (:term:`COLOR_HSV_MIN_S`, :term:`COLOR_HSV_MIN_V`) [1, 0.3]
    and (:term:`COLOR_HSV_MAX_S`, :term:`COLOR_HSV_MAX_V`) [0.1, 1].
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_color_hsv.txt
+
 Thinking in RGB or HSV
 ----------------------
 
@@ -341,6 +358,12 @@ achieved using *c/m/y/k* quadruplets.
    and painted with a specific black ink instead, leading to under-color
    removal of the remaining three pigments.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_cmyk.txt
+
 Obviously, there is no unique way to go from the 3-dimensional RGB
 system to the 4-dimensional CMYK system. So, again, there is a lot of
 hand waving applied in the transformation. Strikingly, CMYK actually

doc/rst/source/cookbook/cpts.rst

@@ -28,6 +28,12 @@ Default ranges, if available, are indicated on the top-right of the scales.
 
    The standard 44 CPTs supported by GMT.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_M_1a.txt
+
 .. _CPT_files_b:
 
 .. figure:: /_images/GMT_App_M_1b.*
@@ -36,6 +42,12 @@ Default ranges, if available, are indicated on the top-right of the scales.
 
    The 30 scientific color maps by Fabio Crameri supported by GMT.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_M_1b.txt
+
 .. _CPT_files_c:
 
 .. figure:: /_images/GMT_App_M_1c.*
@@ -45,6 +57,11 @@ Default ranges, if available, are indicated on the top-right of the scales.
    The 18 categorical CPTs (those ending in "S" are the categorical
    scientific color maps by Fabio Crameri) supported by GMT.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_M_1c.txt
 
 .. _CPT_files_d:
 
@@ -56,6 +73,12 @@ Default ranges, if available, are indicated on the top-right of the scales.
    **Note**: Any GMT CPT can be made cyclic by running :doc:`/makecpt`
    with the **-Ww** option (wrapped = cyclic).
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_M_1d.txt
+
 For additional color tables, visit
 `cpt-city <http://soliton.vm.bytemark.co.uk/pub/cpt-city/>`_ and
 `Scientific Colour-Maps <http://www.fabiocrameri.ch/colourmaps.php>`_.
@@ -83,3 +106,10 @@ and how to switch the color bar around (by using a negative length).
 .. figure:: /_images/GMT_App_M_2.*
    :width: 600 px
    :align: center
+
+
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_M_2.txt

doc/rst/source/cookbook/custom-symbols.rst

@@ -34,6 +34,11 @@ Several custom symbol definitions comes included with GMT (see Figure :ref:`Cust
    Be aware that some symbols may have a hardwired fill or no-fill component,
    while others duplicate what is already available as standard built-in symbols.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_N_1.txt
 
 You may find it convenient to examine some of these and use them as a
 starting point for your own design; they can be found in GMT's

doc/rst/source/cookbook/data-filtering.rst

@@ -38,6 +38,11 @@ diametrical cross-section through the filter weights
 
    Impulse responses for GMT filters.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_J_1.txt
 
 Although the impulse responses look the same in 1-D and 2-D, this is not
 true of the transfer functions; in 1-D the transfer function is the
@@ -64,6 +69,11 @@ they require more work (doubling the width to achieve the same cut-off wavelengt
 
    Transfer functions for 1-D GMT filters.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_J_2.txt
 
 One of the nice things about the gaussian filter is that its transfer
 functions are the same in 1-D and 2-D. Another nice property is that it
@@ -83,6 +93,12 @@ the wavelength at which the transfer function equals 0.5 is about 5.34
 
    Transfer functions for 2-D (radial) GMT filters.
 
+.. toggle::
+
+   Here is the source script for the figure above:
+
+   .. literalinclude:: /_verbatim/GMT_App_J_3.txt
+
 Footnote
 --------