From 3cc7200a4d8c188ba6abcc8a3a863c41c2a2a113 Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Fri, 19 Jan 2024 12:07:45 +0100 Subject: [PATCH] updates software doc --- doc/source/conf.py | 1 + .../source_rst/software/operations/config.rst | 24 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index c298886f..364bab08 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -39,6 +39,7 @@ extensions = [ 'sphinx.ext.mathjax', 'numpydoc', 'recommonmark' + 'linuxdoc.rstFlatTable', ] diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst index 2c92b345..04fcce4c 100644 --- a/doc/source/source_rst/software/operations/config.rst +++ b/doc/source/source_rst/software/operations/config.rst @@ -62,6 +62,30 @@ The configuration is written in a python file structured in a series of dictiona #. HARDWARE_CONFIG: the hardware system in which the five different modules 'ctl' (controller), 'tx' (transmitter), 'rx' (receiver), 'mux' (multiplexers), 'pwr' (power). + +.. flat-table:: flat-table example + :header-rows: 2 + :stub-columns: 1 + :widths: 1 1 1 3 + :class: my-class + :name: my-flat-table + + * - :rspan:`1` Main Key + - :rspan:`1` Module key + - :cspan:`2` Value + + * - head Type + - head Expected Value + - head Description + + * - 'rx' + - 'model' + - string + - 'raspberry_pi' + - contains informations related to controller unit, 'raspberry_pi' only implemented so far + + + +------------+--------------+-----------------------------------------------------------------------------------------+ | Main key | Module_key | Value | | | +============================+==============================+=============================+ -- GitLab