Documentation: Screen CCC values on scolv - Githubissues

swiss-seismological-service / scdetect

A computationally efficient earthquake detection module for SeisComP

https://scdetect.readthedocs.io

GNU Affero General Public License v3.0

15 stars 6 forks source link

Documentation: Screen CCC values on scolv #133

Closed mmesim closed 2 years ago

damb commented 2 years ago

Please make sure that the PR does not contain any unrelated commits.

You can build and view the documentation locally, e.g.

$ export SCDETECT_ROOT=$SEISCOMP_ROOT/src/extras/scdetect
$ cd $SCDETECT_ROOT/doc
$ python build-doc.py
$ $BROWSER build-doc/html/index.html

Make sure the required dependencies for building the documentation are installed.

After building the documentation locally, the documentation should not contain additional errors/warnings which may be attributed to the changes.
Make sure the formatting is correct.
Besides, references and links should be working. Correctly, reference the SeisComP documentation by means of intersphinx.

Is there a reason why the description of how to configuring custom scevent columns is added to the third offline playback example? The second offline playback example contains a Screen results section, as well.

mmesim commented 2 years ago

I'm not planning to do any of these. I'm sorry. You can either edit or delete the pull request.