Commit 3cc7200a authored by Arnaud WATLET's avatar Arnaud WATLET
Browse files

updates software doc

Showing with 25 additions and 0 deletions
+25 -0
...@@ -39,6 +39,7 @@ extensions = [ ...@@ -39,6 +39,7 @@ extensions = [
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'numpydoc', 'numpydoc',
'recommonmark' 'recommonmark'
'linuxdoc.rstFlatTable',
] ]
......
...@@ -62,6 +62,30 @@ The configuration is written in a python file structured in a series of dictiona ...@@ -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). #. 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 | | Main key | Module_key | Value |
| | +============================+==============================+=============================+ | | +============================+==============================+=============================+
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment