Skip to content

Commit 7c9399d

Browse files
committed
Added examples page to docs
1 parent 5519fa7 commit 7c9399d

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

docs/examples.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Examples
2+
========
3+
4+
Below are documented some example programs that were developed for the
5+
package.
6+
7+
Morse
8+
-----
9+
10+
This is a very basic (and not very practical) example of using the man-machine
11+
interface beep signals of a TPS1200+ instrument to encode and relay an ASCII
12+
message in Morse code.
13+
14+
.. code-block:: text
15+
16+
usage: morse.py [-h] port intensity message
17+
18+
positional arguments:
19+
port serial port
20+
intensity beep intensity [1-100]
21+
message message to encode
22+
23+
options:
24+
-h, --help show this help message and exit
25+
26+
.. seealso::
27+
28+
`morse.py <https://github.com/MrClock8163/GeoComPy/blob/main/examples/morse.py>`_
29+
CLI script

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Content
4848

4949
overview
5050
introduction
51+
examples
5152

5253
.. toctree::
5354
:maxdepth: 1

docs/latexindex.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ GeoComPy
1111

1212
overview
1313
introduction
14+
examples
1415

1516
*****************
1617
API documentation

0 commit comments

Comments
 (0)