docs: improvements to source code documentation (#1236)

2023-05-07 15:01:44 -04:00
parent 97f18d6353
commit 979f7f4e60
71 changed files with 1284 additions and 1430 deletions
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -8,16 +8,16 @@ version: 2

 # Set the version of Python
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
  tools:
-    python: "3.10"
+    python: "3.11"
  apt_packages:
    - graphviz

-## Include the submodules, required for cmake
-#  submodules:
-#    include: all
-#    recursive: true
+# submodules required for include statements
+submodules:
+  include: all
+  recursive: true

 # Build documentation in the docs/ directory with Sphinx
 sphinx: