Skip to content

Commit

Permalink
Update docs with captions for code
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Dec 23, 2019
1 parent 6f843f4 commit beb8d11
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Application can then check if GPS signal has been detected as valid and use othe

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

Parse received data from interrupt/DMA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -26,6 +27,7 @@ Data are later processed outside interrupt context.

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

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

.. literalinclude:: ../../examples/example.c
:language: c
:language: c
:caption: Test verification code
1 change: 1 addition & 0 deletions docs/user-manual/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ During the development, test check is performed to validate raw NMEA input data

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

.. toctree::
:maxdepth: 2

0 comments on commit beb8d11

Please sign in to comment.