From 7c3ee7d0ce51cbf61d32d98b7cf2afdd4458f320 Mon Sep 17 00:00:00 2001 From: William Emfinger Date: Fri, 31 Jan 2025 17:30:39 -0600 Subject: [PATCH] fix doc --- doc/en/logger.rst | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/en/logger.rst b/doc/en/logger.rst index 0936ba726..8f48843b3 100644 --- a/doc/en/logger.rst +++ b/doc/en/logger.rst @@ -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