obspy.core.util.base.make_format_plugin_table

make_format_plugin_table(group='waveform', method='read', numspaces=4, unindent_first_line=True)[source]

Returns a markdown formatted table with read waveform plugins to insert in docstrings.

>>> table = make_format_plugin_table("event", "write", 4, True)
>>> print table  
======= ================= =======================================
    Format  Required Module   _`Linked Function Call`
    ======= ================= =======================================
    JSON    :mod:`obspy.core` :func:`obspy.core.json.core.writeJSON`
    QUAKEML :mod:`obspy.core` :func:`obspy.core.quakeml.writeQuakeML`
    ======= ================= =======================================
Parameters:
  • group (str) Plugin group to search (e.g. “waveform” or “event”).
  • method (str) Either ‘read’ or ‘write’ to select plugins based on either read or write capability.
  • numspaces (int) Number of spaces prepended to each line (for indentation in docstrings).
  • unindent_first_line (bool) Determines if first line should start with prepended spaces or not.

This Page