Add missing doc pages for ADIS16XXX

Signed-off-by: Travis F. Collins <travis.collins@analog.com>
analogdevicesinc · Jun 27, 2024 · 826953a · 826953a
1 parent bf10373
commit 826953a
Show file tree

Hide file tree

Showing 15 changed files with 107 additions and 5 deletions.
diff --git a/doc/source/devices/adi.adis16375.rst b/doc/source/devices/adi.adis16375.rst
@@ -0,0 +1,9 @@
+
+adis16375
+=========
+
+.. autoclass:: adi.adis16375
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16460.rst b/doc/source/devices/adi.adis16460.rst
@@ -1,7 +1,8 @@
 adis16460
 ====================
 
-.. automodule:: adi.adis16460
+.. autoclass:: adi.adis16460
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16475.rst b/doc/source/devices/adi.adis16475.rst
@@ -1,7 +1,8 @@
 adis16475
 ====================
 
-.. automodule:: adi.adis16475
+.. autoclass:: adi.adis16475
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16480.rst b/doc/source/devices/adi.adis16480.rst
@@ -1,7 +1,8 @@
 adis16480
 ====================
 
-.. automodule:: adi.adis16480
+.. autoclass:: adi.adis16480
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16485.rst b/doc/source/devices/adi.adis16485.rst
@@ -0,0 +1,9 @@
+
+adis16485
+=========
+
+.. autoclass:: adi.adis16485
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16488.rst b/doc/source/devices/adi.adis16488.rst
@@ -0,0 +1,9 @@
+
+adis16488
+=========
+
+.. autoclass:: adi.adis16488
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16490.rst b/doc/source/devices/adi.adis16490.rst
@@ -0,0 +1,9 @@
+
+adis16490
+=========
+
+.. autoclass:: adi.adis16490
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16495.rst b/doc/source/devices/adi.adis16495.rst
@@ -1,7 +1,9 @@
+
 adis16495
-====================
+=========
 
-.. automodule:: adi.adis16495
+.. autoclass:: adi.adis16495
    :members:
    :undoc-members:
    :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16497.rst b/doc/source/devices/adi.adis16497.rst
@@ -0,0 +1,9 @@
+
+adis16497
+=========
+
+.. autoclass:: adi.adis16497
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16545.rst b/doc/source/devices/adi.adis16545.rst
@@ -0,0 +1,9 @@
+
+adis16545
+=========
+
+.. autoclass:: adi.adis16545
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/adi.adis16547.rst b/doc/source/devices/adi.adis16547.rst
@@ -0,0 +1,9 @@
+
+adis16547
+=========
+
+.. autoclass:: adi.adis16547
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/source/devices/index.rst b/doc/source/devices/index.rst
@@ -61,11 +61,18 @@ Supported Devices
    adi.adf4371
    adi.adf5610
    adi.adg2128
+   adi.adis16375
    adi.adis16460
    adi.adis16475
    adi.adis16480
+   adi.adis16485
+   adi.adis16488
+   adi.adis16490
    adi.adis16495
+   adi.adis16497
    adi.adis16507
+   adi.adis16545
+   adi.adis16547
    adi.adl5240
    adi.adl5960
    adi.admv8818

diff --git a/doc/update_devs.py b/doc/update_devs.py
@@ -15,7 +15,23 @@ def update_devs():
     devices_all = devices + [mfile] if os.path.exists(mfile) else devices
 
     # Remove device docs before updating
+
+    # Autodoc won't generate these pages
+    classes_not_modules = [
+        "adi.adis16375.rst",
+        "adi.adis16480.rst",
+        "adi.adis16485.rst",
+        "adi.adis16488.rst",
+        "adi.adis16490.rst",
+        "adi.adis16495.rst",
+        "adi.adis16497.rst",
+        "adi.adis16545.rst",
+        "adi.adis16547.rst",
+    ]
+
     for dev in devices_all:
+        if os.path.basename(dev) in classes_not_modules:
+            continue
         print("Removing {}".format(dev))
         os.remove(dev)
 
@@ -27,6 +43,8 @@ def update_devs():
 
     # Remove adi. and modules strings
     for dev in devices:
+        if os.path.basename(dev) in classes_not_modules:
+            continue
         with open(dev, "r") as f:
             txt = f.read()
             txt = txt.replace("adi.", "")

diff --git a/supported_parts.md b/supported_parts.md
@@ -135,6 +135,8 @@
 - ADIS16497-2
 - ADIS16497-3
 - ADIS16507
+- ADIS16545
+- ADIS16547
 - ADL5240
 - ADL5960
 - ADMV8818

diff --git a/tasks.py b/tasks.py
@@ -260,10 +260,17 @@ def checkemulation(c):
         "adf4371",
         "adf5610",
         "adg2128",
+        "adis16375",
         "adis16460",
         "adis16475",
+        "adis16485",
+        "adis16488",
+        "adis16490",
         "adis16495",
+        "adis16497",
         "adis16507",
+        "adis16545",
+        "adis16547",
         "adl5240",
         "adl5960",
         "admv8818",