Make "Show Source" useful

[sgdecker]

What can be better?

When looking at the documentation for various functions in the MetPy Reference Guide, in the right column there is an icon followed by "Show Source". However, the information revealed by clicking on "Show Source" is not particularly useful.

For instance, for read_colortable, "Show Source" shows:

read_colortable
===========================

.. currentmodule:: metpy.plots

.. autofunction:: read_colortable

.. include:: metpy.plots.read_colortable.examples

.. raw:: html

      <div style='clear:both'></div>

I would find a display of the actual source code that implements the read_colortable function to be more useful in this context, or perhaps the "raw" text of its docstring.

So for this particular function, I think:

def read_colortable(fobj):
    r"""Read colortable information from a file.

    Reads a colortable, which consists of one color per line of the file, where
    a color can be one of: a tuple of 3 floats, a string with a HTML color name,
    or a string with a HTML hex color.

    Parameters
    ----------
    fobj : file-like object
        A file-like object to read the colors from

    Returns
    -------
    List of tuples
        A list of the RGB color values, where each RGB color is a tuple of 3 floats in the
        range of [0, 1].

    """
    ret = []
    try:
        for line in fobj:
            literal = _parse(line)
            if literal:
                ret.append(mcolors.colorConverter.to_rgb(literal))
        return ret
    except (SyntaxError, ValueError) as e:
        raise RuntimeError(f'Malformed colortable (bad line: {line})') from e

or a subset of the above would be better. But maybe I'm completely missing the point behind these "Show Source" links.

[dcamron]

Oops, we were supposed to hide that, but I misspelled the config never did. This button from the theme is only for the doc source. However, I'll go see about enabling the linkcode extension to add a source button a la NumPy, Pandas, etc.