Deployed fd1b75b with MkDocs version: 1.5.3

pyrocko · Oct 30, 2023 · cbeac23 · cbeac23
1 parent 9b38525
commit cbeac23
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 9 deletions.
diff --git a/components/configuration/index.html b/components/configuration/index.html
@@ -519,6 +519,19 @@
     Example Config
   </a>
 
+    <nav class="md-nav" aria-label="Example Config">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#paths" class="md-nav__link">
+    Paths
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -688,6 +701,19 @@
     Example Config
   </a>
 
+    <nav class="md-nav" aria-label="Example Config">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#paths" class="md-nav__link">
+    Paths
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -794,6 +820,8 @@ <h2 id="example-config">Example Config</h2>
 </span><span id="__span-0-75"><a id="__codelineno-0-75" name="__codelineno-0-75" href="#__codelineno-0-75"></a><span class="w">  </span><span class="nt">&quot;n_threads_argmax&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
 </span><span id="__span-0-76"><a id="__codelineno-0-76" name="__codelineno-0-76" href="#__codelineno-0-76"></a><span class="p">}</span>
 </span></code></pre></div>
+<h3 id="paths">Paths</h3>
+<p>Paths can be relative to the location of the config file or absolute.</p>
 
 
 

diff --git a/components/seismic_data/index.html b/components/seismic_data/index.html
@@ -792,19 +792,19 @@ <h2 id="waveform-data">Waveform Data</h2>
 <dl>
 <dt><strong><code>environment</code></strong></dt>
 <dd>
-<p>Path to Squirrel environment.</p>
+<p>Path to a Squirrel environment.</p>
 </dd>
 <dt><strong><code>waveform_dirs</code></strong></dt>
 <dd>
 <p>List of directories holding the waveform files.</p>
 </dd>
 <dt><strong><code>start_time</code></strong></dt>
 <dd>
-<p>Start time for the search.</p>
+<p>Start time for the search in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601</a>.</p>
 </dd>
 <dt><strong><code>end_time</code></strong></dt>
 <dd>
-<p>End time for the search.</p>
+<p>End time for the search in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601</a>.</p>
 </dd>
 <dt><strong><code>highpass</code></strong></dt>
 <dd>
@@ -816,7 +816,7 @@ <h2 id="waveform-data">Waveform Data</h2>
 </dd>
 <dt><strong><code>channel_selector</code></strong></dt>
 <dd>
-<p>Channel selector for Pyrocko's Squirrel, use e.g. <code>EN?</code> for selection.</p>
+<p>Channel selector for waveforms, use e.g. <code>EN?</code> for selection of all accelerometer data.</p>
 </dd>
 </dl>
 </div>
@@ -853,15 +853,15 @@ <h2 id="meta-data">Meta Data</h2>
 <dl>
 <dt><strong><code>pyrocko_station_yamls</code></strong></dt>
 <dd>
-<p>List of Pyrocko station yaml files.</p>
+<p>List of <a href="https://pyrocko.org/docs/current/formats/yaml.html">Pyrocko station YAML</a> files.</p>
 </dd>
 <dt><strong><code>station_xmls</code></strong></dt>
 <dd>
 <p>List of StationXML files.</p>
 </dd>
 <dt><strong><code>blacklist</code></strong></dt>
 <dd>
-<p>Blacklist as <code>['NET.STA.LOC', ...]</code></p>
+<p>Blacklist stations and exclude from detecion. Format is <code>['NET.STA.LOC', ...]</code></p>
 </dd>
 </dl>
 </div>

diff --git a/components/station_corrections/index.html b/components/station_corrections/index.html
@@ -724,15 +724,15 @@ <h1 id="station-corrections">Station Corrections
 <dl>
 <dt><strong><code>pyrocko_station_yamls</code></strong></dt>
 <dd>
-<p>List of Pyrocko station yaml files.</p>
+<p>List of <a href="https://pyrocko.org/docs/current/formats/yaml.html">Pyrocko station YAML</a> files.</p>
 </dd>
 <dt><strong><code>station_xmls</code></strong></dt>
 <dd>
 <p>List of StationXML files.</p>
 </dd>
 <dt><strong><code>blacklist</code></strong></dt>
 <dd>
-<p>Blacklist as <code>['NET.STA.LOC', ...]</code></p>
+<p>Blacklist stations and exclude from detecion. Format is <code>['NET.STA.LOC', ...]</code></p>
 </dd>
 </dl>
 </div>