docs: Add Sphinx autodoc generation for xcp.net classes

bernhardkaindl · bernhardkaindl · commit cf8229fd116a · 2025-09-26T17:38:22.000+02:00
Signed-off-by: Bernhard Kaindl &lt;bernhard.kaindl@cloud.com&gt;
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,6 +18,11 @@ XenServer Python libs for Dom0
 .. image:: https://img.shields.io/badge/Sphinx-docs-blue.svg
    :target: https://python-libs.onrender.com/
 
+Welcome to the python-libs documentation!
+
+Each module is documented in its own section.
+Select a module from the menu to view its API documentation.
+
 .. toctree::
    :maxdepth: 2
    :caption: Project Documentation
@@ -46,7 +51,20 @@ XenServer Python libs for Dom0
    version
    xmlunwrap
 
-Welcome to the python-libs documentation!
+.. toctree::
+   :maxdepth: 2
+   :caption: XCP.Net Modules
+
+   net/biosdevname
+   net/ip
+   net/mac
 
-Each module is documented in its own section. Select a module from the menu to view its API documentation.
+.. toctree::
+   :maxdepth: 2
+   :caption: XCP.Net.Ifrename Modules
 
+   net/ifrename/ifrename-util
+   net/ifrename/ifrename-static
+   net/ifrename/ifrename-logic
+   net/ifrename/ifrename-dynamic
+   net/ifrename/ifrename-macpci
diff --git a/docs/source/net/biosdevname.rst b/docs/source/net/biosdevname.rst
@@ -0,0 +1,7 @@
+xcp.net.biosdevname
+===================
+
+.. automodule:: xcp.net.biosdevname
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ifrename/ifrename-dynamic.rst b/docs/source/net/ifrename/ifrename-dynamic.rst
@@ -0,0 +1,7 @@
+xcp.net.ifrename.dynamic
+========================
+
+.. automodule:: xcp.net.ifrename.dynamic
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ifrename/ifrename-logic.rst b/docs/source/net/ifrename/ifrename-logic.rst
@@ -0,0 +1,7 @@
+xcp.net.ifrename.logic
+======================
+
+.. automodule:: xcp.net.ifrename.logic
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ifrename/ifrename-macpci.rst b/docs/source/net/ifrename/ifrename-macpci.rst
@@ -0,0 +1,7 @@
+xcp.net.ifrename.macpci
+=======================
+
+.. automodule:: xcp.net.ifrename.macpci
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ifrename/ifrename-static.rst b/docs/source/net/ifrename/ifrename-static.rst
@@ -0,0 +1,7 @@
+xcp.net.ifrename.static
+=======================
+
+.. automodule:: xcp.net.ifrename.static
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ifrename/ifrename-util.rst b/docs/source/net/ifrename/ifrename-util.rst
@@ -0,0 +1,7 @@
+xcp.net.ifrename.util
+=====================
+
+.. automodule:: xcp.net.ifrename.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/ip.rst b/docs/source/net/ip.rst
@@ -0,0 +1,7 @@
+xcp.net.ip
+==========
+
+.. automodule:: xcp.net.ip
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/net/mac.rst b/docs/source/net/mac.rst
@@ -0,0 +1,7 @@
+xcp.net.mac
+===========
+
+.. automodule:: xcp.net.mac
+    :members:
+    :undoc-members:
+    :show-inheritance:
