Enable source code documentation

tangostationcontrol/docs/docs-requirements.txt

 importlib-metadata<2.0.0,>=0.12;python_version<"3.8"
 sphinx>=4.3.2 # BSD
 sphinx-rtd-theme>=1.0.0 # MIT
+sphinxcontrib-apidoc>=0.3.0 #BSD

tangostationcontrol/docs/source/conf.py

@@ -27,7 +27,22 @@ author = "Stichting ASTRON"
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.graphviz"]
+extensions = [
+    "sphinx.ext.graphviz",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.apidoc",
+]
+
+apidoc_module_dir = "../../tangostationcontrol"
+apidoc_output_dir = "source_documentation"
+apidoc_excluded_paths = []
+apidoc_separate_modules = True
+apidoc_toc_file = False
+# This should include private methods but does not work
+# https://github.com/sphinx-contrib/apidoc/issues/14
+apidoc_extra_args = ["--private"]
+
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

tangostationcontrol/docs/source/developer.rst

@@ -3,6 +3,11 @@ Developer information
 
 This chapter describes key areas useful for developers.
 
+.. toctree::
+   :maxdepth: 2
+
+   source_documentation/index
+
 Docker compose
 -------------------------
 

tangostationcontrol/docs/source/source_documentation/index.rst

+Source code documentation
+=========================
+
+.. toctree::
+   :maxdepth: 3
+
+   tangostationcontrol

tangostationcontrol/tangostationcontrol/toolkit/udp_simulator.py

@@ -15,6 +15,7 @@ print(f"UDP target port: {UDP_PORT}")
 
 sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)  # create UDP socket
 
+if __name__ == "__main__":
     while True:
         sock.sendto(bytes(MESSAGE, "utf-8"), (UDP_IP, UDP_PORT))
         i += 1