nqrduck/NQRduckumentation
1
0
Fork 1
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Changed everything to markdown!

Browse source
This commit is contained in:
jupfi 2024-05-11 17:51:45 +02:00
parent 6f0cf88d95
commit d1df79c3e5
2 changed files with 34 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

16
source/index.rst → source/index.md
View file

@ -1,8 +1,6 @@
Welcome to the NQRduckumentation! # Welcome to the NQRduckumentation!
=================================
.. figure:: _static/Logo_full.png ![NQRduck Logo](_static/Logo_full.png)
:alt: NQRduck logo
This program is intended as an educational tool for magnetic resonance experiments (NMR, NQR, ...). Its focus lies on modular behaviour depending on what nqrduck modules are installed. This program is intended as an educational tool for magnetic resonance experiments (NMR, NQR, ...). Its focus lies on modular behaviour depending on what nqrduck modules are installed.
@ -10,14 +8,14 @@ The core of the program is the nqrduck. It provides a central interface for comm
The focus for spectrometers currently lies on LimeSDR based spectrometers (LimeSDR USB, LimeSDR Mini 2.0). The focus for spectrometers currently lies on LimeSDR based spectrometers (LimeSDR USB, LimeSDR Mini 2.0).
```{toctree}
.. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Contents: :caption: Contents:
tutorials/index tutorials/index
api_reference/index api_reference/index
```
## NQRduck core

20
source/tutorials/index.rst → source/tutorials/index.md
View file

@ -1,22 +1,22 @@
NQRduck Tutorials 🦆 # NQRduck Tutorials 🦆
====================
Introduction
------------ ## Introduction
This is a collection of different tutorials for the NQRduck program. This is a collection of different tutorials for the NQRduck program.
.. toctree:: ```{toctree}
:maxdepth: 1 :maxdepth: 1
:caption: Tutorials :caption: Tutorials
tutorial_0 tutorial_0
tutorial_1 tutorial_1
tutorial_2 tutorial_2
```
```{toctree}
.. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Documentation :caption: Documentation
@ -26,9 +26,11 @@ This is a collection of different tutorials for the NQRduck program.
docs/LNA docs/LNA
docs/Transcoupler docs/Transcoupler
docs/DirectionalCoupler docs/DirectionalCoupler
docs/PreAmp
```
## Tutorials in work
Tutorials in work
-----------------
- Automatic Tuning and Matching - This tutorial shows you how to use the Automatic Tuning and Matching module. - Automatic Tuning and Matching - This tutorial shows you how to use the Automatic Tuning and Matching module.