From 44a8750768c4fa453a8040c08c5cacaced251604 Mon Sep 17 00:00:00 2001
From: Arnaud Watlet <arnaud.watlet@umons.ac.be>
Date: Thu, 18 Jan 2024 11:22:41 +0100
Subject: [PATCH] updates config doc
---
configs/config_example.py | 11 ++++++++---
doc/source/source_rst/software/operations/config.rst | 2 +-
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/configs/config_example.py b/configs/config_example.py
index afaaee88..576bb10d 100644
--- a/configs/config_example.py
+++ b/configs/config_example.py
@@ -61,10 +61,15 @@ HARDWARE_CONFIG = {
Parameters
----------
'ctl': dict
- contains informationb related to controller unit with the following keys:
- * 'model': string, model type of the controller. Currently only 'raspberry_pi"
+ Describing the controller unit with the following keys:
+ * 'model': string
+ model type of the controller. Currently only 'raspberry_pi"
'pwr': dict
- 'model': string, model type of the power module. 'pwr_batt', 'pwr_dps5005"
+ Describing the power module with the following keys:
+ * 'model': string,
+ model type of the power module. 'pwr_batt', 'pwr_dps5005"
+ * 'voltage': float
+ default voltage of the
'''
diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst
index 02c0a627..4d06aaf6 100644
--- a/doc/source/source_rst/software/operations/config.rst
+++ b/doc/source/source_rst/software/operations/config.rst
@@ -204,4 +204,4 @@ The configuration is written in a python file structured in a series of dictiona
:maxdepth: 2
:caption: Contents:
-.. autofunction:: HARDWARE_CONFIG
+.. autofunction:: congifs.config_example.HARDWARE_CONFIG
--
GitLab