docs: add members of automodule for Sphinx to pickup classes docstrin…

…gs in the auto documentation (#576)
PaloAltoNetworks · Oct 14, 2024 · e0add15 · e0add15
1 parent 62bcff3
commit e0add15
Show file tree

Hide file tree

Showing 13 changed files with 14 additions and 0 deletions.
diff --git a/docs/module-base.rst b/docs/module-base.rst
@@ -11,3 +11,5 @@ Class Reference
 ---------------
 
 .. automodule:: panos.base
+   :members: PanObject
+   :no-index:
diff --git a/docs/module-device.rst b/docs/module-device.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.device
+   :members:
diff --git a/docs/module-errors.rst b/docs/module-errors.rst
@@ -11,3 +11,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.errors
+   :members:
diff --git a/docs/module-firewall.rst b/docs/module-firewall.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.firewall
+   :members:
diff --git a/docs/module-ha.rst b/docs/module-ha.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.ha
+   :members:
diff --git a/docs/module-network.rst b/docs/module-network.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.network
+   :members:
diff --git a/docs/module-objects.rst b/docs/module-objects.rst
@@ -11,3 +11,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.objects
+   :members:
diff --git a/docs/module-panorama.rst b/docs/module-panorama.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.panorama
+   :members:
diff --git a/docs/module-plugins.rst b/docs/module-plugins.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.plugins
+   :members:
diff --git a/docs/module-policies.rst b/docs/module-policies.rst
@@ -16,3 +16,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.policies
+   :members:
diff --git a/docs/module-predefined.rst b/docs/module-predefined.rst
@@ -11,3 +11,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.predefined
+   :members:
diff --git a/docs/module-updater.rst b/docs/module-updater.rst
@@ -11,3 +11,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.updater
+   :members:
diff --git a/docs/module-userid.rst b/docs/module-userid.rst
@@ -11,3 +11,4 @@ Class Reference
 ---------------
 
 .. automodule:: panos.userid
+   :members:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,3 +16,4 @@ Class Reference
		---------------

		.. automodule:: panos.device
		:members:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,3 +11,4 @@ Class Reference
		---------------

		.. automodule:: panos.errors
		:members: