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`
======... ===============... ========================================...
CMTSOLUTION  :mod:`...io.cmtsolution` :func:`..._write_cmtsolution`
CNV       :mod:`...io.cnv`   :func:`obspy.io.cnv.core._write_cnv`
JSON      :mod:`...io.json`  :func:`obspy.io.json.core._write_json`
KML       :mod:`obspy.io.kml` :func:`obspy.io.kml.core._write_kml`
NLLOC_OBS :mod:`...io.nlloc` :func:`obspy.io.nlloc.core.write_nlloc_obs`
QUAKEML :mod:`...io.quakeml` :func:`obspy.io.quakeml.core._write_quakeml`
SHAPEFILE :mod:`obspy.io.shapefile`
                         :func:`obspy.io.shapefile.core._write_shapefile`
ZMAP      :mod:`...io.zmap`  :func:`obspy.io.zmap.core._write_zmap`
======... ===============... ========================================...
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.