Enabling rtd by adding the required modifications and dependencies

.gitignore

@@ -16,18 +16,29 @@
 .*.swp
 .DS_store
 
-# Local config directories
-/*.egg-info
-
-# Simulated Subversion default ignores end here
-# The contents of the svn:ignore property on the branch root.
-/crash.log
-/tempLog.txt
-/.idea
-/thirdparty
-/documentation/generated
-/documentation/images
-/Data
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
 
 # log files
 *.log
@@ -80,8 +91,16 @@ cover/
 
 # Sphinx documentation
 docs/_build/
+<<<<<<< HEAD
+<<<<<<< HEAD
+docs/_autosummary/
+docs/_static/
+=======
+>>>>>>> 26647177 (Added rtd config and edited files for myst syntax warnings. RTD site should work now, need to improve formatting and layout.)
+=======
 docs/_autosummary/
 docs/_static/
+>>>>>>> 25ee7046 (Got autosummary working with a custom template. There are numerous warnings during the build due to syntax etc but at least the docs render locally. Added several `__init__.py` files to enable autosummary to recurse into submodules. Also some modules were run upon import which broke the build so added `if __name__ == "__main__"` where necessary. For some reason, the widgets submodule actually causes a segfault during the sphinx build which is amazing. I removed the blank `__init__.py` to avoid sphinx recursing into that submodule so the docs can build at least.)
 
 # Jupyter Notebook
 .ipynb_checkpoints
@@ -107,9 +126,12 @@ venv.bak/
 .mypy_cache/
 .dmypy.json
 dmypy.json
+<<<<<<< HEAD
 
 # ruff
 .ruff_cache/
 
 # vscode settings
-.vscode/
+.vscode/
+=======
+>>>>>>> 26647177 (Added rtd config and edited files for myst syntax warnings. RTD site should work now, need to improve formatting and layout.)

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  # Install the project in editable mode using pyproject.toml,
+  # avoids needing a requirements.txt
+  jobs:
+    pre_build:
+      - pip install -e ".[dev-docs]"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true

README.md

@@ -1,6 +1,8 @@
 # qudi-core
 [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
 ![PyPI release](https://github.com/Ulm-IQO/qudi-core/actions/workflows/release_pypi.yml/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/qudi-core-testing/badge/?version=latest)](https://qudi-core-testing.readthedocs.io/en/latest/?badge=latest)
+
 
 ---
 The qudi-core repository represents the base installation for the `qudi` Python package.

docs/404.md

@@ -2,6 +2,7 @@
 permalink: /404.html
 title: Error 404
 description: qudi-core
+orphan: True
 ---
 
 # Uh... have you tried turning it off and on again?

docs/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= --jobs=auto
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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)
+
+clean:
+	rm -rf _build _autosummary

docs/conf.py

@@ -0,0 +1,52 @@
+# 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
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../src/qudi/'))
+
+project = 'qudi-core'
+copyright = '2024, Ulm IQO'
+author = 'Ulm IQO'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+    # 'IPython.sphinxext.ipython_console_highlighting',
+    # 'nbsphinx',
+extensions = [
+    'IPython.sphinxext.ipython_directive',
+    'IPython.sphinxext.ipython_directive',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.viewcode',
+    'numpydoc',
+    'sphinx_rtd_dark_mode',
+]
+
+templates_path = ['templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
+
+autosummary_generate = True
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# html_theme = 'pydata_sphinx_theme'
+# html_theme = 'sphinx_book_theme'
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    "navigation_with_keys": False,  # See https://github.com/pydata/pydata-sphinx-theme/issues/1492
+}
+default_dark_mode = False  # For sphinx_rtd_dark_mode. Dark mode needs tweaking so not defaulting to it yet.
+html_static_path = []  # Normally defaults to '_static' but we don't have any static files.
+
+numpydoc_show_class_members = False
+numpydoc_show_inherited_class_members = False
+numpydoc_class_members_toctree = False