commit 7d0d51a5a9171b0caa4168702a269329c4facfa7 Author: jupfi Date: Fri May 3 15:11:25 2024 +0200 Initial commit. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e5647c9 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..17739b5 --- /dev/null +++ b/.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 diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..e69de29 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/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) diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/extern/nqrduck b/extern/nqrduck new file mode 160000 index 0000000..84b9e98 --- /dev/null +++ b/extern/nqrduck @@ -0,0 +1 @@ +Subproject commit 84b9e98406e12abf35fd1ceb75d72f56e5447ac4 diff --git a/extern/nqrduck-autotm b/extern/nqrduck-autotm new file mode 160000 index 0000000..ccd662c --- /dev/null +++ b/extern/nqrduck-autotm @@ -0,0 +1 @@ +Subproject commit ccd662c503674ddfcd0ad666001082255a875f2a diff --git a/extern/nqrduck-broadband b/extern/nqrduck-broadband new file mode 160000 index 0000000..8b8093b --- /dev/null +++ b/extern/nqrduck-broadband @@ -0,0 +1 @@ +Subproject commit 8b8093b2d9b8dc6898855a18f07a91a10ea81951 diff --git a/extern/nqrduck-measurement b/extern/nqrduck-measurement new file mode 160000 index 0000000..1dff0de --- /dev/null +++ b/extern/nqrduck-measurement @@ -0,0 +1 @@ +Subproject commit 1dff0de7bbd2085b3ddd789f232b7ab4132ab511 diff --git a/extern/nqrduck-pulseprogrammer b/extern/nqrduck-pulseprogrammer new file mode 160000 index 0000000..06a2edc --- /dev/null +++ b/extern/nqrduck-pulseprogrammer @@ -0,0 +1 @@ +Subproject commit 06a2edc640b9dd2572c5d09667cdb73920f61dc1 diff --git a/extern/nqrduck-spectrometer b/extern/nqrduck-spectrometer new file mode 160000 index 0000000..423fb3d --- /dev/null +++ b/extern/nqrduck-spectrometer @@ -0,0 +1 @@ +Subproject commit 423fb3d9a0a5c72899e31a43ca01aba77af7367d diff --git a/extern/nqrduck-spectrometer-limenqr b/extern/nqrduck-spectrometer-limenqr new file mode 160000 index 0000000..2c63fa4 --- /dev/null +++ b/extern/nqrduck-spectrometer-limenqr @@ -0,0 +1 @@ +Subproject commit 2c63fa402813c9aa3de2fbd09299eedbd103349a diff --git a/extern/nqrduck-spectrometer-simulator b/extern/nqrduck-spectrometer-simulator new file mode 160000 index 0000000..1ebda98 --- /dev/null +++ b/extern/nqrduck-spectrometer-simulator @@ -0,0 +1 @@ +Subproject commit 1ebda98a0bca91cfd9bb70fb7b10e13171cd0e78 diff --git a/make.bat b/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/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 diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..ba2277c --- /dev/null +++ b/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", +] diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..53f2ef9 --- /dev/null +++ b/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` diff --git a/source/nqrduck-spectrometer.rst b/source/nqrduck-spectrometer.rst new file mode 100644 index 0000000..a1512de --- /dev/null +++ b/source/nqrduck-spectrometer.rst @@ -0,0 +1,8 @@ +NQRduck Spectrometer +==================== + +.. autosummary:: + :toctree: _autosummary + :recursive: + + nqrduck_spectrometer \ No newline at end of file diff --git a/source/nqrduck.rst b/source/nqrduck.rst new file mode 100644 index 0000000..5fde01f --- /dev/null +++ b/source/nqrduck.rst @@ -0,0 +1,11 @@ +NQRduck +======= + +.. autosummary:: + :toctree: _autosummary + :recursive: + + nqrduck.assets + nqrduck.core + nqrduck.helpers + nqrduck.module