diff --git a/source/index.rst b/source/index.md similarity index 69% rename from source/index.rst rename to source/index.md index cbc96ab..be96819 100644 --- a/source/index.rst +++ b/source/index.md @@ -1,8 +1,6 @@ -Welcome to the NQRduckumentation! -================================= +# Welcome to the NQRduckumentation! -.. figure:: _static/Logo_full.png - :alt: NQRduck logo +![NQRduck Logo](_static/Logo_full.png) 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). +```{toctree} +:maxdepth: 1 +:caption: Contents: - - - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - - tutorials/index - api_reference/index +tutorials/index +api_reference/index +``` +## NQRduck core + + diff --git a/source/tutorials/index.rst b/source/tutorials/index.md similarity index 50% rename from source/tutorials/index.rst rename to source/tutorials/index.md index 28e3a89..ab5b3dd 100644 --- a/source/tutorials/index.rst +++ b/source/tutorials/index.md @@ -1,34 +1,36 @@ -NQRduck Tutorials 🦆 -==================== +# NQRduck Tutorials 🦆 -Introduction ------------- + +## Introduction + This is a collection of different tutorials for the NQRduck program. -.. toctree:: - :maxdepth: 1 - :caption: Tutorials +```{toctree} +:maxdepth: 1 +:caption: Tutorials - tutorial_0 - tutorial_1 - tutorial_2 +tutorial_0 +tutorial_1 +tutorial_2 +``` +```{toctree} +:maxdepth: 1 +:caption: Documentation -.. toctree:: - :maxdepth: 1 - :caption: Documentation +docs/TuningAndMatching +docs/LimeNQR +docs/RFPA +docs/LNA +docs/Transcoupler +docs/DirectionalCoupler +docs/PreAmp +``` - docs/TuningAndMatching - docs/LimeNQR - docs/RFPA - docs/LNA - docs/Transcoupler - docs/DirectionalCoupler +## Tutorials in work -Tutorials in work ------------------ - Automatic Tuning and Matching - This tutorial shows you how to use the Automatic Tuning and Matching module.