From ed5f7259c88decc2155cb5c0319e90319ef0c732 Mon Sep 17 00:00:00 2001
From: Arnaud Watlet <arnaud.watlet@umons.ac.be>
Date: Wed, 17 Jan 2024 15:18:58 +0100
Subject: [PATCH] updates doc software
---
doc/source/source_rst/software/operations/config.rst | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/doc/source/source_rst/software/operations/config.rst b/doc/source/source_rst/software/operations/config.rst
index 6ebba732..0ea77e3c 100644
--- a/doc/source/source_rst/software/operations/config.rst
+++ b/doc/source/source_rst/software/operations/config.rst
@@ -7,7 +7,10 @@ In certain cases, it also allows you to define hardware specifications, such as
For general purpose, most specifications can be left on default values.
.. warning::
-The configuration file defines how the OhmPi system is assembled and is expected to behave. It has a different purpose than the measurement settings which define the acquisition parameters. Several combinations of :ref:`settings` can be handled by one configuration specified in a config.py file.
+ The configuration file defines how the OhmPi system is assembled and expected to behave. Not to be confused with :ref:`settings`. One configuration specified in a config.py file can handle multiple combinations of acquisition settings.
+
+Default configuration
+---------------------
A default version of `config.py` is provided in the repository.
This file should be edited to customize the configuration following the user's needs and preferences.
@@ -38,7 +41,7 @@ The configuration is written in a python file structured in a series of dictionn
:maxdepth: 2
:caption: Contents:
-.. automodule:: configs.config_default
+.. automodule:: ~configs.config_default
:members:
:undoc-members:
:show-inheritance:
--
GitLab