Skip to content

Commit e00412a

Browse files
liunan-mschristopherco
authored andcommitted
fix: disable doc generation for OpenStack clients (cliff sphinxext Python 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.
1 parent fb191cd commit e00412a

6 files changed

Lines changed: 41 additions & 4 deletions

File tree

base/comps/component-check-disablement.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ components = [
127127
"python-markdown_2",
128128
"python-matplotlib",
129129
"python-msrest",
130+
"python-oslo-config",
130131
"python-pandas",
131132
"python-passlib",
132133
"python-pexpect",

base/comps/components-full.toml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4089,7 +4089,6 @@
40894089
[components.python-hatch-requirements-txt]
40904090
[components.python-hatch-vcs]
40914091
[components.python-hatchling]
4092-
[components.python-heatclient]
40934092
[components.python-hpack]
40944093
[components.python-html5lib]
40954094
[components.python-httpbin]
@@ -4206,7 +4205,6 @@
42064205
[components.python-lxml]
42074206
[components.python-lz4]
42084207
[components.python-mako]
4209-
[components.python-manilaclient]
42104208
[components.python-manuel]
42114209
[components.python-mapclassify]
42124210
[components.python-markdown-it-py]
@@ -4264,12 +4262,10 @@
42644262
[components.python-numpydoc]
42654263
[components.python-oauth2client]
42664264
[components.python-oci]
4267-
[components.python-octaviaclient]
42684265
[components.python-olefile]
42694266
[components.python-opcodes]
42704267
[components.python-openpyxl]
42714268
[components.python-openshift]
4272-
[components.python-openstackclient]
42734269
[components.python-openstackdocstheme]
42744270
[components.python-openstacksdk]
42754271
[components.python-openstep-plist]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[components.python-heatclient]
2+
3+
# Disable doc generation to avoid cliff sphinxext Python 3.14 incompatibility.
4+
# TODO: re-enable doc once cliff sphinxext fix is released upstream
5+
# Upstream fix: https://github.com/openstack/cliff/commit/391261c849c994ca2d3f42926497e633047ed8c7
6+
[[components.python-heatclient.overlays]]
7+
description = "Disable doc generation to work around cliff sphinxext Python 3.14 incompatibility"
8+
type = "spec-search-replace"
9+
regex = '^%global with_doc 1$'
10+
replacement = '%global with_doc 0'
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[components.python-manilaclient]
2+
3+
# Disable doc generation to avoid cliff sphinxext Python 3.14 incompatibility.
4+
# TODO: re-enable doc once cliff sphinxext fix is released upstream
5+
# Upstream fix: https://github.com/openstack/cliff/commit/391261c849c994ca2d3f42926497e633047ed8c7
6+
[[components.python-manilaclient.overlays]]
7+
description = "Disable doc generation to work around cliff sphinxext Python 3.14 incompatibility"
8+
type = "spec-search-replace"
9+
regex = '^%global with_doc 1$'
10+
replacement = '%global with_doc 0'
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[components.python-octaviaclient]
2+
3+
# Disable doc generation to avoid cliff sphinxext Python 3.14 incompatibility.
4+
# TODO: re-enable doc once cliff sphinxext fix is released upstream
5+
# Upstream fix: https://github.com/openstack/cliff/commit/391261c849c994ca2d3f42926497e633047ed8c7
6+
[[components.python-octaviaclient.overlays]]
7+
description = "Disable doc generation to work around cliff sphinxext Python 3.14 incompatibility"
8+
type = "spec-search-replace"
9+
regex = '^%global with_doc 1$'
10+
replacement = '%global with_doc 0'
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[components.python-openstackclient]
2+
3+
# Disable doc generation to avoid cliff sphinxext Python 3.14 incompatibility.
4+
# TODO: re-enable doc once cliff sphinxext fix is released upstream
5+
# Upstream fix: https://github.com/openstack/cliff/commit/391261c849c994ca2d3f42926497e633047ed8c7
6+
[[components.python-openstackclient.overlays]]
7+
description = "Disable doc generation to work around cliff sphinxext Python 3.14 incompatibility"
8+
type = "spec-search-replace"
9+
regex = '^%global with_doc 1$'
10+
replacement = '%global with_doc 0'

0 commit comments

Comments
 (0)