Skip to content

Commit

Permalink
Add line numbers to examples
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Dec 27, 2019
1 parent d7208a2 commit 6264d54
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
6 changes: 4 additions & 2 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ In this example, block of data is prepared as big string array and sent to proce
Application can then check if GPS signal has been detected as valid and use other data accordingly.

.. literalinclude:: ../../examples/example.c
:language: c
:language: c
:linenos:
:caption: Minimum example code

Parse received data from interrupt/DMA
Expand All @@ -26,7 +27,8 @@ Data are later processed outside interrupt context.
For the sake of this example, application *implements* interrupts as function call in *while loop*.

.. literalinclude:: ../../examples/example_buff.c
:language: c
:language: c
:linenos:
:caption: Example of buffer

.. toctree::
Expand Down
3 changes: 2 additions & 1 deletion docs/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,6 @@ Minimal example code
Run below example to test and verify library

.. literalinclude:: ../../examples/example.c
:language: c
:language: c
:linenos:
:caption: Test verification code
3 changes: 2 additions & 1 deletion docs/user-manual/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Tests during development
During the development, test check is performed to validate raw NMEA input data vs expected result.

.. literalinclude:: ../../examples/test_code.c
:language: c
:language: c
:linenos:
:caption: Test code for development

.. toctree::
Expand Down

0 comments on commit 6264d54

Please sign in to comment.