Fix broken docs jobs and update-client script

.github/workflows/test.yaml

@@ -7,11 +7,10 @@ jobs:
  runs-on: ubuntu-latest
  strategy:
  matrix:
- python-version: ["3.8", "3.10", "3.11", "3.12"]
+ python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
  include:
- - python-version: "3.9"
+ - python-version: "3.13"
  use_coverage: 'coverage'
-
  steps:
  - uses: actions/checkout@v6
  with:

doc/Makefile

@@ -15,13 +15,8 @@ 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: rst
+html:
 	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	@echo "\nDocs rendered successfully, open _/build/html/index.html to view"
+	@echo "Docs rendered successfully, open _/build/html/index.html to view"

doc/README.md

@@ -8,4 +8,3 @@ $ pip install -r ../test-requirements.txt
 ```
 
 Use `make html` to build the docs in html format.
-

doc/requirements-docs.txt → doc/requirements.txt

@@ -1,2 +1,3 @@
+sphinx
 recommonmark
 sphinx_markdown_tables

doc/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -18,29 +17,7 @@
 
 from recommonmark.transform import AutoStructify
 
-# --
-# Copy README.md, CONTRIBUTING.md to source/ directory and replace
-# all paths to point github files.
-def _copy_with_converting_link_to_repo(filename, new_filename):
- base_url = 'https://github.com/kubernetes-client/python/blob/master/'
-
- def subf(subs):
- label, url = subs.groups()
- if not url.startswith('http://') and not url.startswith('https://'):
- url = base_url + url
- return label + '(' + url + ')'
 
- with open(filename, "r") as r:
- data = re.sub("(\[[^\]]+\])\(([^\)]+)\)", subf, r.read())
-
- with open(new_filename, "w") as w:
- w.write(data)
-
-_copy_with_converting_link_to_repo("../../README.md", "README.md")
-_copy_with_converting_link_to_repo("../../CONTRIBUTING.md", "CONTRIBUTING.md")
-# --
-
-sys.path.insert(0, os.path.abspath('../..'))
 # -- General configuration ----------------------------------------------------
 
 source_suffix = ['.rst', '.md']
@@ -50,23 +27,17 @@ def subf(subs):
 extensions = [
  'sphinx_markdown_tables',
  'recommonmark',
- 'sphinx.ext.autodoc',
- #'sphinx.ext.intersphinx',
 ]
 
-# autodoc generation is a bit aggressive and a nuisance when doing heavy
-# text edit cycles.
-# execute "export SPHINX_DEBUG=1" in your terminal to disable
-
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
-project = u'kubernetes-python-client'
-copyright = u'2017, Kubernetes'
+project = 'kubernetes-python-client'
+copyright = '2017-present, Kubernetes'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -78,33 +49,36 @@ def subf(subs):
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-# -- Options for HTML output --------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = '_theme'
-# html_static_path = ['static']
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = '%sdoc' % project
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass
-# [howto/manual]).
-latex_documents = [
- ('index',
- '%s.tex' % project,
- u'%s Documentation' % project,
- u'Kubernetes', 'manual'),
-]
 
-# Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
+# Copy README.md, CONTRIBUTING.md to source/ directory and replace
+# all paths to point github files.
+def _copy_with_converting_link_to_repo(filename, new_filename):
+ base_url = 'https://github.com/kubernetes-client/python/blob/master/'
+
+ def subf(subs):
+ label, url = subs.groups()
+ if not url.startswith('http://') and not url.startswith('https://'):
+ url = base_url + url
+ return label + '(' + url + ')'
+
+ with open(filename, "r") as r:
+ data = re.sub("(\[[^\]]+\])\(([^\)]+)\)", subf, r.read())
+
+ with open(new_filename, "w") as w:
+ w.write(data)
+
+
+_copy_with_converting_link_to_repo("../../README.md", "README.md")
+_copy_with_converting_link_to_repo("../../CONTRIBUTING.md", "CONTRIBUTING.md")
+
+
 def setup(app):
- app.add_config_value('recommonmark_config', {
+ app.add_config_value(
+ 'recommonmark_config',
+ {
  'auto_toc_tree_section': 'Contents',
  'enable_eval_rst': True,
- }, True)
+ },
+ True,
+ )
  app.add_transform(AutoStructify)
-

doc/source/index.rst

@@ -1,27 +1,10 @@
-.. kubernetes-python-client documentation master file, created by
- sphinx-quickstart on Tue Jul 9 22:26:36 2013.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to kubernetes-python-client's documentation!
-========================================================
-
-Contents:
+kubernetes-python-client
+========================
 
 .. toctree::
  :maxdepth: 2
 
  README <README.md>
  installation
  usage
- examples
- modules
  contributing <CONTRIBUTING.md>
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-