Add autoapi to crawl our modules and populate the docs

c-salomonsen · c-salomonsen · commit d6128d79a1ec · 2025-02-04T19:16:07.000+01:00
Uses the docstrings of our code to generate documentation.
diff --git a/doc/conf.py b/doc/conf.py
@@ -7,8 +7,12 @@
 
 extensions = [
     "myst_parser",  # in order to use markdown
+    "autoapi.extension",  # in order to generate API documentation
 ]
 
+# search this directory for Python files
+autoapi_dirs = ["../utils"]
+
 myst_enable_extensions = [
     "colon_fence",  # ::: can be used instead of ``` for better rendering
 ]

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,12 @@`
`7`	`7`
`8`	`8`	`extensions = [`
`9`	`9`	`"myst_parser", # in order to use markdown`
	`10`	`+ "autoapi.extension", # in order to generate API documentation`
`10`	`11`	`]`
`11`	`12`
	`13`	`+# search this directory for Python files`
	`14`	`+autoapi_dirs = ["../utils"]`
	`15`	`+`
`12`	`16`	`myst_enable_extensions = [`
`13`	`17`	"colon_fence", # ::: can be used instead of ``` for better rendering
`14`	`18`	`]`