Merge pull request #41 from analogdevicesinc/tfcollins/doc-python-bin…

…dings Add doc for python bindings
analogdevicesinc · Oct 4, 2024 · da3fb49 · da3fb49
2 parents 7a20df0 + bf195f0
commit da3fb49
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -30,6 +30,7 @@ Reference
    03_examples
    reference
    reference_advanced
+   python/genalyzer
 
 
 

diff --git a/doc/python/genalyzer.advanced.rst b/doc/python/genalyzer.advanced.rst
@@ -0,0 +1,8 @@
+Advanced API
+============
+
+
+.. automodule:: genalyzer.advanced.advanced
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/python/genalyzer.rst b/doc/python/genalyzer.rst
@@ -0,0 +1,12 @@
+Python Bindings
+===============
+
+Component APIs
+--------------
+
+.. toctree::
+   :maxdepth: 4
+
+   genalyzer.simplified
+   genalyzer.advanced
+
diff --git a/doc/python/genalyzer.simplified.rst b/doc/python/genalyzer.simplified.rst
@@ -0,0 +1,7 @@
+Simplified API
+============
+
+.. automodule:: genalyzer.simplified
+   :members:
+   :undoc-members:
+   :show-inheritance: