Decommission agent_based_api.v1: prepare sphinx

Change-Id: I9a1dc2bb62671655dbc76b04a8397a0542cc3419
Checkmk · Oct 18, 2024 · 4879124 · 4879124
1 parent 623a144
commit 4879124
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 25 deletions.
diff --git a/doc/plugin-api/source/cmk.agent_based/index.rst b/doc/plugin-api/source/cmk.agent_based/index.rst
@@ -2,11 +2,17 @@
 Agent based ("Check API")
 =========================
 
-Version 1
+Version 2
 =========
 
- .. automodule:: cmk.base.plugins.agent_based.agent_based_api
-   :members:
+.. toctree::
+
+   v2
+   v2.clusterize
+   v2.render
+
+Version 1 (Checkmk 2.2.0 - 2.3.0)
+=================================
 
 .. toctree::
 
@@ -15,12 +21,3 @@ Version 1
    v1.register
    v1.render
    v1.type_defs
-
-Version 2
-=========
-
-.. toctree::
-
-   v2
-   v2.clusterize
-   v2.render
diff --git a/doc/plugin-api/source/cmk.agent_based/v1.clusterize.rst b/doc/plugin-api/source/cmk.agent_based/v1.clusterize.rst
@@ -1,7 +1,7 @@
 =============================
-agent_based_api.v1.clusterize
+cmk.agent_based.v1.clusterize
 =============================
 
-.. automodule:: cmk.base.plugins.agent_based.agent_based_api.v1.clusterize
+.. automodule:: cmk.agent_based.v1.clusterize
    :members:
    :show-inheritance:
diff --git a/doc/plugin-api/source/cmk.agent_based/v1.register.rst b/doc/plugin-api/source/cmk.agent_based/v1.register.rst
@@ -1,7 +1,7 @@
 ===========================
-agent_based_api.v1.register
+cmk.agent_based.v1.register
 ===========================
 
-.. automodule:: cmk.base.plugins.agent_based.agent_based_api.v1.register
+.. automodule:: cmk.agent_based.v1.register
    :members:
    :show-inheritance:
diff --git a/doc/plugin-api/source/cmk.agent_based/v1.render.rst b/doc/plugin-api/source/cmk.agent_based/v1.render.rst
@@ -1,7 +1,7 @@
 =========================
-agent_based_api.v1.render
+cmk.agent_based.v1.render
 =========================
 
-.. automodule:: cmk.base.plugins.agent_based.agent_based_api.v1.render
+.. automodule:: cmk.agent_based.v1.render
    :members:
    :show-inheritance:
diff --git a/doc/plugin-api/source/cmk.agent_based/v1.rst b/doc/plugin-api/source/cmk.agent_based/v1.rst
@@ -1,7 +1,7 @@
 ==================
-agent_based_api.v1
+cmk.agent_based.v1
 ==================
 
-.. automodule:: cmk.base.plugins.agent_based.agent_based_api.v1
+.. automodule:: cmk.agent_based.v1
    :members:
    :show-inheritance:
diff --git a/doc/plugin-api/source/cmk.agent_based/v1.type_defs.rst b/doc/plugin-api/source/cmk.agent_based/v1.type_defs.rst
@@ -1,7 +1,7 @@
 ============================
-agent_based_api.v1.type_defs
+cmk.agent_based.v1.type_defs
 ============================
 
-.. automodule:: cmk.base.plugins.agent_based.agent_based_api.v1.type_defs
+.. automodule:: cmk.agent_based.v1.type_defs
    :members:
    :show-inheritance:
diff --git a/doc/plugin-api/source/conf.py b/doc/plugin-api/source/conf.py
@@ -49,9 +49,9 @@
 # The better way to deal with it would be to create a dedicated venv for the plugin API doc
 # generator which pulls in our packages as dependencies. This way we would ensure that all
 # dependencies are available during the sphinx execution. But since the documented modules
-# cmk.base.plugins.bakery.bakery_api, cmk.base.plugins.agent_based.agent_based_api and
-# cmk.cee.dcd.plugins.connectors.connectors_api are not separate packages right now, we can
-# not move on with this.
+# cmk.base.plugins.bakery.bakery_api and
+# cmk.cee.dcd.plugins.connectors.connectors_api
+# are not separate packages right now, we can not move on with this.
 autodoc_mock_imports = [
     "cmk.trace",
     "livestatus",