Fix broken docs jobs and update-client script #2498
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These have not built successfully for a long-time (over two years [1] at time of writing). We should work to re-add these but lets focus on getting out openapi-generator version bumped first. [1] https://app.readthedocs.org/projects/kubernetes/builds/ Signed-off-by: Stephen Finucane <[email protected]>
Update examples that were moved in kubernetes-client#938 and fix title underlines (docutils cares about this stuff). Signed-off-by: Stephen Finucane <[email protected]>
Remove Python 2 stuff as well as unused or commented out configuration values. Also add sphinx to the dependencies Signed-off-by: Stephen Finucane <[email protected]>
Use more recent Python versions and remove use of the build_sphinx distutils command which hasn't existed for many years now. Signed-off-by: Stephen Finucane <[email protected]>
k8s-ci-robot
added
release-note-none
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: stephenfin The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/XXL
Python 3.13 is the latest and greatest. Signed-off-by: Stephen Finucane <[email protected]>
We will subsequently overlay our own commits on this. We also stop setting OPENAPI_GENERATOR_COMMIT: this is already being set by the 'openapi/python.sh' from 'kubernetes-client/gen' so setting it here is very misleading. With this change, any user should now be able to run e.g.: USERNAME=kubernetes CLIENT_ROOT=../kubernetes ./scripts/update-client.sh and see zero changes (assuming kubernetes/kubernetes is in fact cloned to the parent directory). Signed-off-by: Stephen Finucane <[email protected]>
stephenfin
force-pushed
the
fix-openapi-generator-sync
branch
from
cd87cd5 to
a7008b0
Compare
This was replacing the wrong method. Signed-off-by: Stephen Finucane <[email protected]>
This was referenced Jan 9, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
While working on #2496 and #2497, I noticed that running the
update-client.shscript generated some unexpected changes to files. Upon further inspection, it appears files and hunks were the result of previous PRs that should have instead been applies as patches to the client (via theupdate-client.shscript).In addition, I also noticed that docs builds were returning a lot of errors, mainly because the generator is generating syntactically invalid reStructuredText docstrings. This has led to a long-term failure to build the docs.
I resolve all issues in this PR via a series of commits that do the following:
pydocto explore the API until then.toxagainupdate-client.shso that we layer on required changesThis should set us up nicely for a future PR that will update
openapi-generatorto a less ancient version. I am working on this currently.Which issue(s) this PR fixes:
Special notes for your reviewer:
I don't know why the maintainers aren't seeing these issues locally: perhaps they are and have local tooling to help workaround them. In any case, I would encourage you to go through this PR commit by commit and to feel free to drop anything that doesn't make sense.
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: