From 68a5c27544c24783f7c35fb275595cfc486148aa Mon Sep 17 00:00:00 2001 From: jupfi Date: Mon, 13 May 2024 11:24:08 +0200 Subject: [PATCH] Added software architecture skeleton files. --- source/index.md | 4 +++- source/software_structure/communication.md | 1 + source/software_structure/index.md | 10 ++++++++++ source/software_structure/modules.md | 1 + source/software_structure/style.md | 1 + 5 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 source/software_structure/communication.md create mode 100644 source/software_structure/index.md create mode 100644 source/software_structure/modules.md create mode 100644 source/software_structure/style.md diff --git a/source/index.md b/source/index.md index 8752d3c..5ff5295 100644 --- a/source/index.md +++ b/source/index.md @@ -20,7 +20,8 @@ The NQRduck can be easily installed via pip. Additional modules can be installed There exists a range of different modules for the NQRduck software. The tutorials range from simulation to magnetic resonance experiments. ::: :::{grid-item-card} -{fab}`python;pst-color-primary` **Python** +:link: software_structure/index.html +{fab}`python;pst-color-primary` **Sotware Structure** ^^^ The NQRduck comes with a user friendly PyQt6 based user interface. Different Python modules can be installed via pip to customize the functionality of the program. ::: @@ -41,5 +42,6 @@ The focus for spectrometers currently lies on LimeSDR based spectrometers (LimeS :caption: Contents: tutorials/index +software_structure/index api_reference/index ``` \ No newline at end of file diff --git a/source/software_structure/communication.md b/source/software_structure/communication.md new file mode 100644 index 0000000..7e37400 --- /dev/null +++ b/source/software_structure/communication.md @@ -0,0 +1 @@ +# Communication \ No newline at end of file diff --git a/source/software_structure/index.md b/source/software_structure/index.md new file mode 100644 index 0000000..c989abf --- /dev/null +++ b/source/software_structure/index.md @@ -0,0 +1,10 @@ +# NQRduck Software Structure + +```{toctree} +:maxdepth: 1 +:caption: Contents: + +modules +communication +style +``` \ No newline at end of file diff --git a/source/software_structure/modules.md b/source/software_structure/modules.md new file mode 100644 index 0000000..016d434 --- /dev/null +++ b/source/software_structure/modules.md @@ -0,0 +1 @@ +# Modules \ No newline at end of file diff --git a/source/software_structure/style.md b/source/software_structure/style.md new file mode 100644 index 0000000..d9339e2 --- /dev/null +++ b/source/software_structure/style.md @@ -0,0 +1 @@ +# Style \ No newline at end of file