diff --git a/doc/source/source_rst/software/installation.rst b/doc/source/source_rst/software/installation.rst index dea18295cfbce2b34e1fa7514a17469f0e144ab0..19242cc17080903cc9aa908a4cba1bcbbd9ffdc3 100644 --- a/doc/source/source_rst/software/installation.rst +++ b/doc/source/source_rst/software/installation.rst @@ -3,12 +3,12 @@ Getting started Step 1: Set up the Raspberry Pi =============================== -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 +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. -For all questions related to Raspberry Pi operations, please refer to the official documentation_. +For all questions related to Raspberry Pi operations, please refer to the official d`ocumentation`_. .. _documentation: https://www.raspberrypi.com/documentation/ Step 2: Clone the OhmPi project diff --git a/doc/source/source_rst/software/operations/interfaces.rst b/doc/source/source_rst/software/operations/interfaces.rst index f20addbf179dd6f9bd0c33740d4f826de402b23d..27cddb246d994f4cc34184c118dc8b411d75bc93 100644 --- a/doc/source/source_rst/software/operations/interfaces.rst +++ b/doc/source/source_rst/software/operations/interfaces.rst @@ -101,6 +101,7 @@ To access the Python API, make sure that the PYTHONPATH has been correctly confi For detailed usage, please see the Python API or look at the examples. + .. _IoT-interface: IoT interface ============= diff --git a/doc/source/source_rst/software/operations/loggers.rst b/doc/source/source_rst/software/operations/loggers.rst index 0ee74247a1bd545cdd2faed137171aafc4b4ed03..189b52eb8fe529b0f2c51459e602129881bef19a 100644 --- a/doc/source/source_rst/software/operations/loggers.rst +++ b/doc/source/source_rst/software/operations/loggers.rst @@ -2,7 +2,7 @@ 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 `MQTT 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 `IoT-interface`_ 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.