Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
finger563 committed Jan 31, 2025
1 parent ab0e287 commit 7c3ee7d
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions doc/en/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,38 @@ runtime.

Code examples for the logging API are provided in the `logger` example folder.

Binary Logger
.. ------------------------------- Example -------------------------------------
.. toctree::

logger_example

.. ---------------------------- API Reference ----------------------------------
API Reference
-------------

The binary logger provides a wrapper around
.. include-build-file:: inc/logger.inc

Binary Log
----------

The binary log component provides a wrapper around
https://github.com/p-ranav/binary_log for enabling compact binary logging of
basic integer, floating point, and string data types.

Code examples for the binary logging API are provided in the `binary_logger`
Code examples for the binary logging API are provided in the `binary_log`
example folder.

.. ------------------------------- Example -------------------------------------
.. toctree::

logger_example
binary_logger_example
binary_log_example

.. ---------------------------- API Reference ----------------------------------
API Reference
-------------

.. include-build-file:: inc/logger.inc
.. include-build-file:: inc/binary-logger.inc
.. include-build-file:: inc/binary-log.inc

0 comments on commit 7c3ee7d

Please sign in to comment.