SCRUG-NA/2025
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[installation] Change to nightly

Browse Source
This commit is contained in:
Dirk Rössler
2025-10-30 12:04:59 +01:00
parent 2ff097f9d1
commit a31bc45cce
1441 changed files with 60368 additions and 56360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

226
share/doc/seiscomp/html/base/contributing-docs.html
View File

@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Contributing Documentation &#8212; SeisComP Release documentation</title>
<title>Contributing Documentation &#8212; SeisComP Development documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=72bcf2f2" />
@ -12,7 +12,7 @@
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
<script type="text/javascript" src="../_static/seiscomp.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=823bb831"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=744d344a"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<link rel="index" title="Index" href="../genindex.html" />
@ -25,8 +25,8 @@
<div class="container">
<div class="brand">
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
<!-- span class="title">SeisComP Release</span -->
<span class="version">6.9.0</span>
<!-- span class="title">SeisComP Development</span -->
<span class="version">7.0.0</span>
</div>
</div>
</div>
@ -74,16 +74,15 @@ It aims to document the configuration and command line options for
consistent way. The functionality of <cite>SeisComP</cite> differs between
versions so the documentation is versioned along with <cite>SeisComP</cite>.
For more general topics and tutorials please refer to the
<a class="reference external" href="https://www.seiscomp.de/">SeisComP wiki</a> <a class="footnote-reference brackets" href="#id2" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.</p>
<p>The documentation is written in <a class="reference external" href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> <a class="footnote-reference brackets" href="#id4" id="id5" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a> (reST) a
simple text mark up format. The documentation is generated using <a class="reference external" href="https://www.sphinx-doc.org/">Sphinx</a> <a class="footnote-reference brackets" href="#id6" id="id7" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a>
which is used to create the <a class="reference external" href="https://docs.python.org/">Python documentation</a> <a class="footnote-reference brackets" href="#id8" id="id9" role="doc-noteref"><span class="fn-bracket">[</span>4<span class="fn-bracket">]</span></a>.
The Sphinx website has a very good
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">introduction to reST</a> <a class="footnote-reference brackets" href="#id10" id="id11" role="doc-noteref"><span class="fn-bracket">[</span>5<span class="fn-bracket">]</span></a> and also covers the Sphinx specific
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html">directives</a> <a class="footnote-reference brackets" href="#id12" id="id13" role="doc-noteref"><span class="fn-bracket">[</span>6<span class="fn-bracket">]</span></a>.</p>
<cite>SeisComP</cite> website and documentation <span id="id2">[<a class="reference internal" href="references.html#id290" title="Helmholtz-Centre Potsdam - GFZ German Research Centre for Geosciences and gempa GmbH. The SeisComP seismological software package. GFZ Data Services. 2008. URL: https://www.seiscomp.de, doi:10.5880/GFZ.2.4.2020.003.">76</a>]</span>.</p>
<p>The documentation is written in <span id="id3"><em>reStructuredText</em> [<a class="reference internal" href="references.html#id226" title="reStructuredText. Source Forge. URL: https://docutils.sourceforge.io/rst.html.">37</a>]</span> (reST) a simple text
mark up format. The documentation is generated using Sphinx <span id="id4">[<a class="reference internal" href="references.html#id302" title="Sphinx. online. URL: https://www.sphinx-doc.org.">27</a>]</span>
which is used to create the Python documentation <span id="id5">[<a class="reference internal" href="references.html#id215" title="Python documentation. Python. URL: https://docs.python.org/.">23</a>]</span>.
The Sphinx website <span id="id6">[<a class="reference internal" href="references.html#id227" title="reStructuredText - Introduction. Sphinx documentation. URL: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html.">36</a>]</span> has a very good
introduction to reST and also covers the Sphinx-specific
directives <span id="id7">[<a class="reference internal" href="references.html#id228" title="reStructuredText - Directives. Sphinx documentation. URL: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html.">35</a>]</span>.</p>
<p>If you would like to add to this documentation or you find an error, then please
submit a patch to <a class="reference external" href="https://github.com/SeisComP">SeisComP on GitHub</a> <a class="footnote-reference brackets" href="#id14" id="id15" role="doc-noteref"><span class="fn-bracket">[</span>7<span class="fn-bracket">]</span></a> or report to the
SeisComP <a class="reference external" href="https://forum.seiscomp.de">discussion forum</a> <a class="footnote-reference brackets" href="#id16" id="id17" role="doc-noteref"><span class="fn-bracket">[</span>8<span class="fn-bracket">]</span></a>.</p>
submit a patch to <span id="id8"><em>SeisComP on GitHub</em> [<a class="reference internal" href="references.html#id291" title="Seiscomp on github. URL: https://github.com/SeisComP.">1</a>]</span> or report to the <span id="id9"><em>SeisComP forum</em> [<a class="reference internal" href="references.html#id289" title="SeisComP forum. GFZ. URL: https://forum.seiscomp.de/.">26</a>]</span>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Please understand the <a class="reference internal" href="style-guide.html#documentation-style-guide"><span class="std std-ref">documentation style guide</span></a>
@ -95,47 +94,50 @@ source. The source and the documentation files for executables (see below) are
good starting points for a new patch.</p>
<section id="documenting-executables">
<h2>Documenting Executables<a class="headerlink" href="#documenting-executables" title="Permalink to this heading"></a></h2>
<p>The documentation for executables is generated from two sources:</p>
<p>The documentation for modules and plugins is generated from two sources:</p>
<dl>
<dt>‘executable’.xml</dt><dd><p>An XML file that contains a brief description of the command,
markup describing the command line parameters, and any
configuration parameters for the executable. Each parameter should
<dt>‘executable’.xml</dt><dd><p>An <a class="reference internal" href="#contributing-documentation-xml"><span class="std std-ref">XML file</span></a> that contains a brief
description of the command, markup describing the command line parameters,
and any configuration parameters for the executable. Each parameter should
have a brief description of the purpose of the parameter.</p>
<p>The description should be plain text and not contain reST markup. Where parameters are common across
a number of executables they should be placed in the appropriate common file and referred to using
their publicID.</p>
<p>The description should be plain text and not contain reST markup. Where
parameters are common across a number of executables they should be placed
in the appropriate common file and referred to using their publicID.</p>
<p>All XML files live in the <code class="file docutils literal notranslate"><span class="pre">doc/apps</span></code> directory of the source
distribution or in <code class="file docutils literal notranslate"><span class="pre">etc/descriptions</span></code> of an installation.</p>
</dd>
<dt>‘executable’.rst</dt><dd><p>This is a text file in reST markup that gives any more-detailed description and examples for the executable.
It is combined with the corresponding .xml to create the full documentation.
The first entry in the file should be a paragraph giving a more
detailed description of the executable.</p>
<dt>‘executable’.rst</dt><dd><p>This is a RST text file in <span class="xref std std-ref">reST markup</span> that gives
any more-detailed description and examples for modules or plugins. It is
combined with the corresponding <code class="file docutils literal notranslate"><span class="pre">executable.xml</span></code> file to create the
full HTML documentation and man pages of a module or plugin.</p>
<p>When listed in a table of content, the RST file allows generating general
content without providing an XML file. Examples can be found in the
<a class="reference external" href="https://github.com/SeisComP/seiscomp/blob/master/doc/templates/index.rst">documentation index file</a> <a class="footnote-reference brackets" href="#id10" id="id11" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> .</p>
<p>The first entry in the file should be a paragraph giving a more
detailed description of the executable. The following paragraphs provide
background information, use cases and examples.</p>
</dd>
</dl>
<p>These two files should be placed in a <code class="file docutils literal notranslate"><span class="pre">descriptions</span></code> sub-directory of the
respective module, e.g. <code class="file docutils literal notranslate"><span class="pre">src/seedlink/apps/seedlink/descriptions/seedlink.rst</span></code>.
The intention is that the documentation is close to the code to make it easier for developers to keep the
documentation up to date with code changes.</p>
<p>For a new executable an entry should also be made in the man section of <code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>.
The man page is a short form of the documentation that is generated from only the .xml file.</p>
</section>
<section id="images">
<h2>Images<a class="headerlink" href="#images" title="Permalink to this heading"></a></h2>
<p>Any images should be placed in a suitable sub-directory of <code class="file docutils literal notranslate"><span class="pre">descriptions/media</span></code>.
Read the <span class="xref std std-ref">documentation on image styles</span> for more details.
The images can then be referred to (in .rst) like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>.. figure:: media/scolv/scolv-overview.png
:width: 16cm
:align: center
Overview of the defrobnicator switches in :ref:`scolv`.
respective module or plugin, e.g., the <a class="reference external" href="https://github.com/SeisComP/main/blob/master/apps/gui-qt/scolv/descriptions/">scolv description</a> <a class="footnote-reference brackets" href="#id12" id="id13" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a> .
The intention is that the documentation is close to the code to make it easier
for developers to keep the documentation up to date with code changes.</p>
<p>For a new executable an entry can also be made in the man section of
<code class="file docutils literal notranslate"><span class="pre">conf.py</span></code>. For <cite>SeisComP</cite> modules located, <a class="reference external" href="https://github.com/SeisComP/seiscomp/tree/master/doc/templates">documentation templates directory</a> <a class="footnote-reference brackets" href="#id14" id="id15" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a>.</p>
<p>The man page is a short form of the documentation of a module that is generated
from the XML and the RST files.
Example:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>man<span class="w"> </span>scolv
</pre></div>
</div>
<p>The images will be moved to the correct location during the documentation build.</p>
</section>
<section id="creating-the-rst">
<h2>Creating the RST<a class="headerlink" href="#creating-the-rst" title="Permalink to this heading"></a></h2>
<p>The RST file should be written according to the
<a class="reference internal" href="style-guide.html#documentation-style-guide"><span class="std std-ref">documentation style guide</span></a>.</p>
</section>
<section id="understanding-the-xml">
<h2>Understanding the XML<a class="headerlink" href="#understanding-the-xml" title="Permalink to this heading"></a></h2>
<span id="contributing-documentation-xml"></span><h2>Understanding the XML<a class="headerlink" href="#understanding-the-xml" title="Permalink to this heading"></a></h2>
<p>As mentioned before XML is used to generate brief descriptions of the configuration and command line parameters.
This section describes the XML format.</p>
<p>Any description XML uses the root element <em>seiscomp</em>:</p>
@ -145,10 +147,13 @@ This section describes the XML format.</p>
<span class="nt">&lt;/seiscomp&gt;</span>
</pre></div>
</div>
<p>Three elements are used inside the root element: <a class="reference internal" href="#xml-module"><span class="std std-ref">module</span></a>, <a class="reference internal" href="#xml-plugin"><span class="std std-ref">plugin</span></a> and <a class="reference internal" href="#xml-binding"><span class="std std-ref">binding</span></a>.
Modules, plugins and bindings can be described in one XML or split up into one file per description. It is better to
have things as close as possible. A module and its binding should go into one module.XML whereas plugins should
go into separate XML files.</p>
<p>Three elements are used inside the root element: <a class="reference internal" href="#xml-module"><span class="std std-ref">module</span></a>,
<a class="reference internal" href="#xml-plugin"><span class="std std-ref">plugin</span></a> and <a class="reference internal" href="#xml-binding"><span class="std std-ref">binding</span></a>.
Modules, plugins and bindings can be described in one XML or split up into one
file per description. It is better to have things as close as possible. A module
and its binding should go into one module.XML whereas plugins should go into
separate XML files. Examples can be found in the source code as well as in the
XML files installed in <code class="file docutils literal notranslate"><span class="pre">seiscomp/etc/descriptions</span></code>.</p>
<section id="module">
<span id="xml-module"></span><h3>Module<a class="headerlink" href="#module" title="Permalink to this heading"></a></h3>
<p>A template for a description XML file can be found in <code class="file docutils literal notranslate"><span class="pre">doc/templates/app.xml</span></code>.</p>
@ -413,27 +418,64 @@ level.</p></td>
type which can be interpreted by a
configurator to provide specialized input
widgets. It is also important for the user
how the parameter is read by the module.</p></td>
how the parameter is read by the module.
Supported are: <em>uint, list:uint, int, list:uint,
double, list:double, float, list:float, file,
list:file, directory, list:directory, time
list:time, host-with-port, boolean, gradient</em></p></td>
</tr>
<tr class="row-even"><td><p><strong>unit</strong></p></td>
<tr class="row-even"><td><p><strong>options</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>Options to type if type is file or directory.
Supported: <em>read, write, execute</em></p></td>
</tr>
<tr class="row-odd"><td><p><strong>unit</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>An optional unit such as “s” or “km” or
“deg”.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>default</strong></p></td>
<tr class="row-even"><td><p><strong>default</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>The default value the module uses if this
parameter is not configured.</p></td>
</tr>
<tr class="row-even"><td><p><strong>description</strong></p></td>
<tr class="row-odd"><td><p><strong>values</strong></p></td>
<td><p>element
attrib</p></td>
<td><p>no</p></td>
<td><p>Lists the supported value separated by comma. For
files, the list describes file name suffices.</p></td>
</tr>
<tr class="row-even"><td><p><strong>range</strong></p></td>
<td><p>element
attrib</p></td>
<td><p>no</p></td>
<td><p>The range of values. Format: minimum:maximum</p></td>
</tr>
<tr class="row-odd"><td><p><strong>description</strong></p></td>
<td><p>element</p></td>
<td><p>no</p></td>
<td><p>Gives a brief description of the parameter.</p></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Further explanations of <strong>type</strong>:</p>
<ul class="simple">
<li><p>uint: Non-negative integer. Example values: 0, 1</p></li>
<li><p>gradient: Colon-separated pairs of value and color. Example:
-4:”rgb(0,0,255)”.</p></li>
<li><p>host-with-port: Colon-separated pairs of host address and port number.
Example: localhost:8080.</p></li>
<li><p>time: Any <a class="reference internal" href="time-grammar.html#time-formats"><span class="std std-ref">time format supported by SeisComP</span></a> is
possible unless stated differently.</p></li>
<li><p>list: One ore more values separated by comma.</p></li>
</ul>
</div>
<p id="xml-configuration-struct">Element: <strong>struct</strong></p>
<table class="docutils align-default">
<thead>
@ -451,7 +493,12 @@ parameter is not configured.</p></td>
used in a configurator to give a selection
of available types to be instantiated.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>link</strong></p></td>
<tr class="row-odd"><td><p><strong>title</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>The title of the struct as shown, e.g. in scconfig</p></td>
</tr>
<tr class="row-even"><td><p><strong>link</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>The absolute reference parameter as it would
@ -472,28 +519,56 @@ locator.profile.teleseismic.param<span class="w"> </span><span class="o">=</span
</div>
</td>
</tr>
<tr class="row-even"><td><p><strong>description</strong></p></td>
<tr class="row-odd"><td><p><strong>description</strong></p></td>
<td><p>element</p></td>
<td><p>no</p></td>
<td><p>Gives a brief description of the parameter.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>parameter</strong></p></td>
<tr class="row-even"><td><p><strong>parameter</strong></p></td>
<td><p>element</p></td>
<td><p>no</p></td>
<td><p>Describes a parameter in the struct. See
<a class="reference internal" href="#xml-configuration-parameter"><span class="std std-ref">parameter</span></a>.</p></td>
</tr>
<tr class="row-even"><td><p><strong>struct</strong></p></td>
<tr class="row-odd"><td><p><strong>struct</strong></p></td>
<td><p>element</p></td>
<td><p>no</p></td>
<td><p>Describes a struct part of this struct.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>group</strong></p></td>
<tr class="row-even"><td><p><strong>group</strong></p></td>
<td><p>element</p></td>
<td><p>no</p></td>
<td><p>Describes a group part of this struct. See
<a class="reference internal" href="#xml-configuration-group"><span class="std std-ref">group</span></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><strong>aliases</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>Explains where to find alias parameters.</p></td>
</tr>
</tbody>
</table>
<p id="xml-configuration-extend-struct">Element: <strong>extend-struct</strong></p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>XML type</p></th>
<th class="head"><p>Mandatory</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><strong>type</strong></p></td>
<td><p>attrib</p></td>
<td><p>yes</p></td>
<td><p>The name of the struct type to be extended. This</p></td>
</tr>
<tr class="row-odd"><td><p><strong>match-name</strong></p></td>
<td><p>attrib</p></td>
<td><p>no</p></td>
<td><p>The name given of the struct with parameters
extending name the struct given by name.</p></td>
</tr>
</tbody>
</table>
<p id="xml-configuration-group">Element: <strong>group</strong></p>
@ -552,7 +627,7 @@ groups, parameters and structures.</p>
<span class="w"> </span><span class="nt">&lt;/description&gt;</span>
<span class="w"> </span><span class="nt">&lt;/parameter&gt;</span>
<span class="w"> </span><span class="nt">&lt;parameter</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;outputPath&quot;</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;path&quot;</span><span class="w"> </span><span class="na">default=</span><span class="s">&quot;/tmp/sc3.nll&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;parameter</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;outputPath&quot;</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;directory&quot;</span><span class="w"> </span><span class="na">default=</span><span class="s">&quot;/tmp/sc3.nll&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;description&gt;</span>
<span class="w"> </span>Defines<span class="w"> </span>the<span class="w"> </span>output<span class="w"> </span>path<span class="w"> </span>for<span class="w"> </span>all<span class="w"> </span>native<span class="w"> </span>NonLinLoc<span class="w"> </span>input<span class="w"> </span>and
<span class="w"> </span>output<span class="w"> </span>files.
@ -722,6 +797,9 @@ all defined options.</p></td>
<span class="w"> </span>...
<span class="w"> </span><span class="nt">&lt;/configuration&gt;</span>
<span class="w"> </span><span class="nt">&lt;command-line&gt;</span>
<span class="w"> </span><span class="nt">&lt;synopsis&gt;</span>
<span class="w"> </span>scautoloc<span class="w"> </span>[options]
<span class="w"> </span><span class="nt">&lt;/synopsis&gt;</span>
<span class="w"> </span><span class="nt">&lt;group</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;Generic&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;optionReference&gt;</span>generic#help<span class="nt">&lt;/optionReference&gt;</span>
<span class="w"> </span><span class="nt">&lt;optionReference&gt;</span>generic#version<span class="nt">&lt;/optionReference&gt;</span>
@ -760,37 +838,17 @@ all defined options.</p></td>
<section id="references">
<h2>References<a class="headerlink" href="#references" title="Permalink to this heading"></a></h2>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id2" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">1</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://www.seiscomp.de/">https://www.seiscomp.de/</a></p>
</aside>
<aside class="footnote brackets" id="id4" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id5">2</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://docutils.sourceforge.io/rst.html">https://docutils.sourceforge.io/rst.html</a></p>
</aside>
<aside class="footnote brackets" id="id6" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id7">3</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://www.sphinx-doc.org/">https://www.sphinx-doc.org/</a></p>
</aside>
<aside class="footnote brackets" id="id8" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id9">4</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://docs.python.org/">https://docs.python.org/</a></p>
</aside>
<aside class="footnote brackets" id="id10" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id11">5</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html</a></p>
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id11">1</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://github.com/SeisComP/seiscomp/blob/master/doc/templates/index.rst">https://github.com/SeisComP/seiscomp/blob/master/doc/templates/index.rst</a></p>
</aside>
<aside class="footnote brackets" id="id12" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id13">6</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html">https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html</a></p>
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id13">2</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://github.com/SeisComP/main/blob/master/apps/gui-qt/scolv/descriptions/">https://github.com/SeisComP/main/blob/master/apps/gui-qt/scolv/descriptions/</a></p>
</aside>
<aside class="footnote brackets" id="id14" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id15">7</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://github.com/SeisComP">https://github.com/SeisComP</a></p>
</aside>
<aside class="footnote brackets" id="id16" role="doc-footnote">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id17">8</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://forum.seiscomp.de">https://forum.seiscomp.de</a></p>
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id15">3</a><span class="fn-bracket">]</span></span>
<p><a class="reference external" href="https://github.com/SeisComP/seiscomp/tree/master/doc/templates">https://github.com/SeisComP/seiscomp/tree/master/doc/templates</a></p>
</aside>
</aside>
</section>
@ -818,7 +876,7 @@ all defined options.</p></td>
<ul>
<li><a class="reference internal" href="#">Contributing Documentation</a><ul>
<li><a class="reference internal" href="#documenting-executables">Documenting Executables</a></li>
<li><a class="reference internal" href="#images">Images</a></li>
<li><a class="reference internal" href="#creating-the-rst">Creating the RST</a></li>
<li><a class="reference internal" href="#understanding-the-xml">Understanding the XML</a><ul>
<li><a class="reference internal" href="#module">Module</a></li>
<li><a class="reference internal" href="#plugin">Plugin</a></li>
@ -862,7 +920,7 @@ all defined options.</p></td>
</a>
<div class="stretched align-center fitted content">
<div>
Version <b>6.9.0</b> Release
Version <b>7.0.0</b> Development
</div>
<div class="copyright">
Copyright &copy; gempa GmbH, GFZ Potsdam.