From d38e40bf2a4507dcac607836d3c574bc89906600 Mon Sep 17 00:00:00 2001 From: Arnaud Watlet <arnaud.watlet@umons.ac.be> Date: Wed, 17 Jan 2024 14:14:40 +0100 Subject: [PATCH] updates doc software --- doc/source/index.rst | 2 +- doc/source/source_rst/software/index.rst | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 doc/source/source_rst/software/index.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index b6a8fdce..82d6df97 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -35,7 +35,7 @@ Contents: source_rst/Ohmpi source_rst/hardware - source_rst/software + source_rst/software/index source_rst/troubleshooting source_rst/developments source_rst/gallery diff --git a/doc/source/source_rst/software/index.rst b/doc/source/source_rst/software/index.rst new file mode 100644 index 00000000..ccdecd5b --- /dev/null +++ b/doc/source/source_rst/software/index.rst @@ -0,0 +1,18 @@ +Software and operation +###################### + +.. warning:: + **OhmPi is a participative project open to all, it requires skills in electronics and to respect the safety rules. OhmPi must be assembled in a professional context and by people competent in electronics. The OhmPi team cannot be held responsible for any material or human damage which would be associated with the use or the assembly of OhmPi. The OhmPi team cannot be held responsible if the equipment does not work after assembly.** + +This section details describes the Python software and how to interact with an OhmPi instrument. + +Contents: + +.. toctree:: + :maxdepth: 2 + + Software architecture <software/architecture> + Getting started <software/installation> + Operation <software/operations> + Monitoring <software/monitoring> + API reference <software/api> -- GitLab