fix: disable doc generation for OpenStack clients (cliff sphinxext Python 3.14)#16459
Merged
christopherco merged 1 commit intotomls/base/mainfrom Apr 4, 2026
Merged
fix: disable doc generation for OpenStack clients (cliff sphinxext Python 3.14)#16459christopherco merged 1 commit intotomls/base/mainfrom
christopherco merged 1 commit intotomls/base/mainfrom
Conversation
liunan-ms
requested review from
christopherco,
ddstreetmicrosoft and
reubeno
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Disables documentation generation for several OpenStack client RPMs to work around a Python 3.14 incompatibility in cliff.sphinxext, and disables %check for python-oslo-config due to an argparse-related test failure.
Changes:
- Add spec overlays to set
%global with_doc 0forpython-heatclient,python-manilaclient,python-octaviaclient, andpython-openstackclient. - Remove those components’ bare entries from
components-full.toml(since they now have dedicated*.comp.tomlfiles). - Add
python-oslo-configto the global check-skip list.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| base/comps/python-openstackclient/python-openstackclient.comp.toml | New overlay disabling doc generation (with_doc 0) with upstream reference/TODO. |
| base/comps/python-octaviaclient/python-octaviaclient.comp.toml | New overlay disabling doc generation (with_doc 0) with upstream reference/TODO. |
| base/comps/python-manilaclient/python-manilaclient.comp.toml | New overlay disabling doc generation (with_doc 0) with upstream reference/TODO. |
| base/comps/python-heatclient/python-heatclient.comp.toml | New overlay disabling doc generation (with_doc 0) with upstream reference/TODO. |
| base/comps/components-full.toml | Removes bare component entries for the newly-dedicated components. |
| base/comps/component-check-disablement.toml | Disables %check for python-oslo-config via the check-skip component group. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
base/comps/python-openstackclient/python-openstackclient.comp.toml
Outdated
Show resolved
Hide resolved
…thon 3.14) cliff's sphinxext uses argparse._format_actions_usage() which was removed in Python 3.14. Disable doc generation via spec overlay (%global with_doc 0) for python-heatclient, python-manilaclient, python-octaviaclient, and python-openstackclient until the upstream cliff fix (openstack/cliff@391261c) is released. Also add python-oslo-config to check-skip-initial-failures. Add ^ and $ anchors to prevent unintended substring matches on commented lines or other macro uses. Consistent with the pattern used in python-stestr.comp.toml.
christopherco
force-pushed
the
liunan/disable_doc
branch
from
3bbac39 to
187f859
Compare
christopherco
approved these changes
Apr 4, 2026
Collaborator
christopherco
left a comment
christopherco
left a comment
There was a problem hiding this comment.
I squashed the changes together since this is all one logical change and so the rebase merge has the proper final git history after merge. Re-ran testing and came back green. 
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
cliff's
sphinxextusesargparse._format_actions_usage()which was removed in Python 3.14.This PR disables doc generation via spec overlay (%global with_doc 0) for
python-heatclient,python-manilaclient,python-octaviaclient, andpython-openstackclientuntil the upstream cliff fix (openstack/cliff@391261c) is released.Also disables %check for
python-oslo-configwhich has a test failure also due to argparse removal in python 3.14.Validation: Koji build