Initial commit.

.gitignore

@@ -0,0 +1,45 @@
+# sphinx build folder
+build
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store?
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Editor backup files #
+#######################
+*~
+
+# Auto-generated files #
+#######################
+_autosummary

.gitmodules

@@ -0,0 +1,24 @@
+[submodule "extern/nqrduck"]
+	path = extern/nqrduck
+	url = https://github.com/nqrduck/nqrduck
+[submodule "extern/nqrduck-spectrometer"]
+	path = extern/nqrduck-spectrometer
+	url = https://github.com/nqrduck/nqrduck-spectrometer
+[submodule "extern/nqrduck-spectrometer-limenqr"]
+	path = extern/nqrduck-spectrometer-limenqr
+	url = https://github.com/nqrduck/nqrduck-spectrometer-limenqr
+[submodule "extern/nqrduck-spectrometer-simulator"]
+	path = extern/nqrduck-spectrometer-simulator
+	url = https://github.com/nqrduck/nqrduck-spectrometer-simulator
+[submodule "extern/nqrduck-measurement"]
+	path = extern/nqrduck-measurement
+	url = https://github.com/nqrduck/nqrduck-measurement
+[submodule "extern/nqrduck-pulseprogrammer"]
+	path = extern/nqrduck-pulseprogrammer
+	url = https://github.com/nqrduck/nqrduck-pulseprogrammer
+[submodule "extern/nqrduck-autotm"]
+	path = extern/nqrduck-autotm
+	url = https://github.com/nqrduck/nqrduck-autotm
+[submodule "extern/nqrduck-broadband"]
+	path = extern/nqrduck-broadband
+	url = https://github.com/nqrduck/nqrduck-broadband

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

extern/nqrduck

@@ -0,0 +1 @@
+Subproject commit 84b9e98406e12abf35fd1ceb75d72f56e5447ac4

extern/nqrduck-autotm

@@ -0,0 +1 @@
+Subproject commit ccd662c503674ddfcd0ad666001082255a875f2a

extern/nqrduck-broadband

@@ -0,0 +1 @@
+Subproject commit 8b8093b2d9b8dc6898855a18f07a91a10ea81951

extern/nqrduck-measurement

@@ -0,0 +1 @@
+Subproject commit 1dff0de7bbd2085b3ddd789f232b7ab4132ab511

extern/nqrduck-pulseprogrammer

@@ -0,0 +1 @@
+Subproject commit 06a2edc640b9dd2572c5d09667cdb73920f61dc1

extern/nqrduck-spectrometer

@@ -0,0 +1 @@
+Subproject commit 423fb3d9a0a5c72899e31a43ca01aba77af7367d

extern/nqrduck-spectrometer-limenqr

@@ -0,0 +1 @@
+Subproject commit 2c63fa402813c9aa3de2fbd09299eedbd103349a

extern/nqrduck-spectrometer-simulator

@@ -0,0 +1 @@
+Subproject commit 1ebda98a0bca91cfd9bb70fb7b10e13171cd0e78

make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

source/conf.py

@@ -0,0 +1,59 @@
+import os
+import sys
+
+# Get the modules from the extern folder
+sys.path.insert(0, os.path.abspath("../extern/nqrduck/src/nqrduck"))
+sys.path.insert(
+    0, os.path.abspath("../extern/nqrduck-spectrometer/src/nqrduck_spectrometer")
+)
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "NQRduckumentation"
+copyright = "2024, jupfi"
+author = "jupfi"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    'sphinx.ext.todo',
+]
+autosummary_generate = True
+
+autodoc_default_options = {
+    "members": True,
+}
+
+# This is required for readthedocs to work with PyQt6
+autodoc_mock_imports = [
+    "matplotlib",
+    "PyQt6.QtWidgets",
+    "PyQt6.QtCore",
+    "PyQt6.QtGui",
+    "ModuleView",
+    "ModuleController",
+    "nqrduck.module.module",
+]

source/index.rst

@@ -0,0 +1,23 @@
+.. NQRduckumentation documentation master file, created by
+   sphinx-quickstart on Fri May  3 13:24:59 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the NQRduckumentation!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Code Documentation:
+
+   nqrduck
+   nqrduck-spectrometer
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

source/nqrduck-spectrometer.rst

@@ -0,0 +1,8 @@
+NQRduck Spectrometer
+====================
+
+.. autosummary::
+    :toctree: _autosummary
+    :recursive:
+
+    nqrduck_spectrometer

source/nqrduck.rst

@@ -0,0 +1,11 @@
+NQRduck
+=======
+
+.. autosummary::
+    :toctree: _autosummary
+    :recursive:
+
+    nqrduck.assets
+    nqrduck.core
+    nqrduck.helpers
+    nqrduck.module