From 4caa5b1a3daacb74d5c5b96329e696030a6df899 Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Wed, 17 Jan 2024 14:41:06 +0100 Subject: [PATCH] updates doc software --- doc/source/source_rst/software/installation.rst | 2 +- doc/source/source_rst/software/operations/config.rst | 1 + doc/source/source_rst/software/operations/loggers.rst | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/source/source_rst/software/installation.rst b/doc/source/source_rst/software/installation.rst index 19242cc1..e8d5ed75 100644 --- a/doc/source/source_rst/software/installation.rst +++ b/doc/source/source_rst/software/installation.rst @@ -3,7 +3,7 @@ Getting started Step 1: Set up the Raspberry Pi =============================== -First, install an operating system on the Raspberry Pi by following the official `instructions`_. +First, install an operating system on the Raspberry Pi by following the official instructions`_. .. _instructions : https://www.raspberrypi.com/documentation/computers/getting-started.html#install-an-operating-system Then connect to the Raspberry Pi either via ssh or using an external monitor. diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index de28fc86..2ab27e3a 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -1,3 +1,4 @@ + .. _config: Configuration ************* diff --git a/doc/source/source_rst/software/operations/loggers.rst b/doc/source/source_rst/software/operations/loggers.rst index 189b52eb..249956ce 100644 --- a/doc/source/source_rst/software/operations/loggers.rst +++ b/doc/source/source_rst/software/operations/loggers.rst @@ -2,10 +2,10 @@ Loggers ******* Loggers have been introduced in this release. They use the excellent logging python package. -Specific handlers have been implemented for running with ohmpi.py (one for logging to an mqtt broker (see `IoT-interface`_ for more details) and one for creating zipped rotated logs on disk). +Specific handlers have been implemented for running with ohmpi.py (one for logging to an mqtt broker (see :ref:`IoT-interfaces` for more details) and one for creating zipped rotated logs on disk). Two loggers have been defined. The first one is dedicated to log operations execution. It is named exec_logger. The second one, named data_logger, is dedicated to log data. A third one is planned to log the state of health (SOH) of the system in a future version. -By default, logs are written to the console (print-like), stored locally in files (a zip is created after some time i.e. every day and/or when the size of the log exceeds a maximum size) and sent to an MQTT broker. Different logging levels may be defined for the different logs and handlers in the `Configuration file`_. +By default, logs are written to the console (print-like), stored locally in files (a zip is created after some time i.e. every day and/or when the size of the log exceeds a maximum size) and sent to an MQTT broker. Different logging levels may be defined for the different logs and handlers in the :ref:`config`. Advanced users may write new handlers and edit the `setup_loggers.py` file to customize the logging mechanisms to their needs. -- GitLab