kubernetes-client · k8s-ci-robot · Jun 13, 2023 · Mar 5, 2023
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -1,4 +1,3 @@
 source/README.md
 source/CONTRIBUTING.md
-source/kubernetes.*
 build
diff --git a/doc/Makefile b/doc/Makefile
@@ -15,9 +15,13 @@ help:
 
 .PHONY: help Makefile
 
+# additional step to use sphinx-apidoc to generate rst files for APIs
+rst:
+	rm -f $(SOURCEDIR)/kubernetes.*.rst
+	$(SPHINXAPIDOC) -o "$(SOURCEDIR)" ../kubernetes/ -e -f
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-html:
-	$(SPHINXAPIDOC) -o "$(SOURCEDIR)" ../kubernetes/ -e -f
+html: rst
 	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@echo "\nDocs rendered successfully, open _/build/html/index.html to view"
diff --git a/doc/source/kubernetes.client.api.admissionregistration_api.rst b/doc/source/kubernetes.client.api.admissionregistration_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.admissionregistration\_api module
+=======================================================
+
+.. automodule:: kubernetes.client.api.admissionregistration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.admissionregistration_v1_api.rst b/doc/source/kubernetes.client.api.admissionregistration_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.admissionregistration\_v1\_api module
+===========================================================
+
+.. automodule:: kubernetes.client.api.admissionregistration_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.admissionregistration_v1alpha1_api.rst b/doc/source/kubernetes.client.api.admissionregistration_v1alpha1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.admissionregistration\_v1alpha1\_api module
+=================================================================
+
+.. automodule:: kubernetes.client.api.admissionregistration_v1alpha1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apiextensions_api.rst b/doc/source/kubernetes.client.api.apiextensions_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apiextensions\_api module
+===============================================
+
+.. automodule:: kubernetes.client.api.apiextensions_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apiextensions_v1_api.rst b/doc/source/kubernetes.client.api.apiextensions_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apiextensions\_v1\_api module
+===================================================
+
+.. automodule:: kubernetes.client.api.apiextensions_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apiregistration_api.rst b/doc/source/kubernetes.client.api.apiregistration_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apiregistration\_api module
+=================================================
+
+.. automodule:: kubernetes.client.api.apiregistration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apiregistration_v1_api.rst b/doc/source/kubernetes.client.api.apiregistration_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apiregistration\_v1\_api module
+=====================================================
+
+.. automodule:: kubernetes.client.api.apiregistration_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apis_api.rst b/doc/source/kubernetes.client.api.apis_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apis\_api module
+======================================
+
+.. automodule:: kubernetes.client.api.apis_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apps_api.rst b/doc/source/kubernetes.client.api.apps_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apps\_api module
+======================================
+
+.. automodule:: kubernetes.client.api.apps_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.apps_v1_api.rst b/doc/source/kubernetes.client.api.apps_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.apps\_v1\_api module
+==========================================
+
+.. automodule:: kubernetes.client.api.apps_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.authentication_api.rst b/doc/source/kubernetes.client.api.authentication_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.authentication\_api module
+================================================
+
+.. automodule:: kubernetes.client.api.authentication_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.authentication_v1_api.rst b/doc/source/kubernetes.client.api.authentication_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.authentication\_v1\_api module
+====================================================
+
+.. automodule:: kubernetes.client.api.authentication_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.authentication_v1alpha1_api.rst b/doc/source/kubernetes.client.api.authentication_v1alpha1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.authentication\_v1alpha1\_api module
+==========================================================
+
+.. automodule:: kubernetes.client.api.authentication_v1alpha1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.authorization_api.rst b/doc/source/kubernetes.client.api.authorization_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.authorization\_api module
+===============================================
+
+.. automodule:: kubernetes.client.api.authorization_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.authorization_v1_api.rst b/doc/source/kubernetes.client.api.authorization_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.authorization\_v1\_api module
+===================================================
+
+.. automodule:: kubernetes.client.api.authorization_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.autoscaling_api.rst b/doc/source/kubernetes.client.api.autoscaling_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.autoscaling\_api module
+=============================================
+
+.. automodule:: kubernetes.client.api.autoscaling_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.autoscaling_v1_api.rst b/doc/source/kubernetes.client.api.autoscaling_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.autoscaling\_v1\_api module
+=================================================
+
+.. automodule:: kubernetes.client.api.autoscaling_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.autoscaling_v2_api.rst b/doc/source/kubernetes.client.api.autoscaling_v2_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.autoscaling\_v2\_api module
+=================================================
+
+.. automodule:: kubernetes.client.api.autoscaling_v2_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.batch_api.rst b/doc/source/kubernetes.client.api.batch_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.batch\_api module
+=======================================
+
+.. automodule:: kubernetes.client.api.batch_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.batch_v1_api.rst b/doc/source/kubernetes.client.api.batch_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.batch\_v1\_api module
+===========================================
+
+.. automodule:: kubernetes.client.api.batch_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.certificates_api.rst b/doc/source/kubernetes.client.api.certificates_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.certificates\_api module
+==============================================
+
+.. automodule:: kubernetes.client.api.certificates_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.certificates_v1_api.rst b/doc/source/kubernetes.client.api.certificates_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.certificates\_v1\_api module
+==================================================
+
+.. automodule:: kubernetes.client.api.certificates_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.coordination_api.rst b/doc/source/kubernetes.client.api.coordination_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.coordination\_api module
+==============================================
+
+.. automodule:: kubernetes.client.api.coordination_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.coordination_v1_api.rst b/doc/source/kubernetes.client.api.coordination_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.coordination\_v1\_api module
+==================================================
+
+.. automodule:: kubernetes.client.api.coordination_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.core_api.rst b/doc/source/kubernetes.client.api.core_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.core\_api module
+======================================
+
+.. automodule:: kubernetes.client.api.core_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.core_v1_api.rst b/doc/source/kubernetes.client.api.core_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.core\_v1\_api module
+==========================================
+
+.. automodule:: kubernetes.client.api.core_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.custom_objects_api.rst b/doc/source/kubernetes.client.api.custom_objects_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.custom\_objects\_api module
+=================================================
+
+.. automodule:: kubernetes.client.api.custom_objects_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.discovery_api.rst b/doc/source/kubernetes.client.api.discovery_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.discovery\_api module
+===========================================
+
+.. automodule:: kubernetes.client.api.discovery_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.discovery_v1_api.rst b/doc/source/kubernetes.client.api.discovery_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.discovery\_v1\_api module
+===============================================
+
+.. automodule:: kubernetes.client.api.discovery_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.events_api.rst b/doc/source/kubernetes.client.api.events_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.events\_api module
+========================================
+
+.. automodule:: kubernetes.client.api.events_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.events_v1_api.rst b/doc/source/kubernetes.client.api.events_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.events\_v1\_api module
+============================================
+
+.. automodule:: kubernetes.client.api.events_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.flowcontrol_apiserver_api.rst b/doc/source/kubernetes.client.api.flowcontrol_apiserver_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.flowcontrol\_apiserver\_api module
+========================================================
+
+.. automodule:: kubernetes.client.api.flowcontrol_apiserver_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.flowcontrol_apiserver_v1beta2_api.rst b/doc/source/kubernetes.client.api.flowcontrol_apiserver_v1beta2_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.flowcontrol\_apiserver\_v1beta2\_api module
+=================================================================
+
+.. automodule:: kubernetes.client.api.flowcontrol_apiserver_v1beta2_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.flowcontrol_apiserver_v1beta3_api.rst b/doc/source/kubernetes.client.api.flowcontrol_apiserver_v1beta3_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.flowcontrol\_apiserver\_v1beta3\_api module
+=================================================================
+
+.. automodule:: kubernetes.client.api.flowcontrol_apiserver_v1beta3_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.internal_apiserver_api.rst b/doc/source/kubernetes.client.api.internal_apiserver_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.internal\_apiserver\_api module
+=====================================================
+
+.. automodule:: kubernetes.client.api.internal_apiserver_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.internal_apiserver_v1alpha1_api.rst b/doc/source/kubernetes.client.api.internal_apiserver_v1alpha1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.internal\_apiserver\_v1alpha1\_api module
+===============================================================
+
+.. automodule:: kubernetes.client.api.internal_apiserver_v1alpha1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.logs_api.rst b/doc/source/kubernetes.client.api.logs_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.logs\_api module
+======================================
+
+.. automodule:: kubernetes.client.api.logs_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.networking_api.rst b/doc/source/kubernetes.client.api.networking_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.networking\_api module
+============================================
+
+.. automodule:: kubernetes.client.api.networking_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.networking_v1_api.rst b/doc/source/kubernetes.client.api.networking_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.networking\_v1\_api module
+================================================
+
+.. automodule:: kubernetes.client.api.networking_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.networking_v1alpha1_api.rst b/doc/source/kubernetes.client.api.networking_v1alpha1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.networking\_v1alpha1\_api module
+======================================================
+
+.. automodule:: kubernetes.client.api.networking_v1alpha1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.node_api.rst b/doc/source/kubernetes.client.api.node_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.node\_api module
+======================================
+
+.. automodule:: kubernetes.client.api.node_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.node_v1_api.rst b/doc/source/kubernetes.client.api.node_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.node\_v1\_api module
+==========================================
+
+.. automodule:: kubernetes.client.api.node_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.openid_api.rst b/doc/source/kubernetes.client.api.openid_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.openid\_api module
+========================================
+
+.. automodule:: kubernetes.client.api.openid_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.policy_api.rst b/doc/source/kubernetes.client.api.policy_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.policy\_api module
+========================================
+
+.. automodule:: kubernetes.client.api.policy_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.policy_v1_api.rst b/doc/source/kubernetes.client.api.policy_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.policy\_v1\_api module
+============================================
+
+.. automodule:: kubernetes.client.api.policy_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.rbac_authorization_api.rst b/doc/source/kubernetes.client.api.rbac_authorization_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.rbac\_authorization\_api module
+=====================================================
+
+.. automodule:: kubernetes.client.api.rbac_authorization_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/kubernetes.client.api.rbac_authorization_v1_api.rst b/doc/source/kubernetes.client.api.rbac_authorization_v1_api.rst
@@ -0,0 +1,7 @@
+kubernetes.client.api.rbac\_authorization\_v1\_api module
+=========================================================
+
+.. automodule:: kubernetes.client.api.rbac_authorization_v1_api
+   :members:
+   :undoc-members:
+   :show-inheritance: