Merge pull request #330486 from anthonyroussel/openstack-sphinx-docs

This commit is contained in:
Sandro
2024-07-28 22:16:49 +02:00
committed by GitHub
10 changed files with 121 additions and 45 deletions
@@ -5,21 +5,21 @@
autopage,
cmd2,
importlib-metadata,
installShellFiles,
openstackdocstheme,
pbr,
prettytable,
pyparsing,
pyyaml,
setuptools,
stevedore,
sphinx,
sphinxHook,
callPackage,
}:
buildPythonPackage rec {
pname = "cliff";
version = "4.7.0";
format = "setuptools";
pyproject = true;
src = fetchPypi {
inherit pname version;
@@ -32,13 +32,15 @@ buildPythonPackage rec {
rm test-requirements.txt
'';
nativeBuildInputs = [
installShellFiles
build-system = [
openstackdocstheme
sphinx
setuptools
sphinxHook
];
propagatedBuildInputs = [
sphinxBuilders = [ "man" ];
dependencies = [
autopage
cmd2
importlib-metadata
@@ -49,11 +51,6 @@ buildPythonPackage rec {
stevedore
];
postInstall = ''
sphinx-build -a -E -d doc/build/doctrees -b man doc/source doc/build/man
installManPage doc/build/man/cliff.1
'';
# check in passthru.tests.pytest to escape infinite recursion with stestr
doCheck = false;
@@ -2,8 +2,11 @@
lib,
buildPythonPackage,
fetchPypi,
openstackdocstheme,
pbr,
six,
setuptools,
sphinxHook,
wrapt,
callPackage,
}:
@@ -11,16 +14,23 @@
buildPythonPackage rec {
pname = "debtcollector";
version = "3.0.0";
format = "setuptools";
pyproject = true;
src = fetchPypi {
inherit pname version;
hash = "sha256-KokX0lsOHx0NNl08HG7Px6UiselxbooaSpFRJvfM6m8=";
};
nativeBuildInputs = [ pbr ];
build-system = [
openstackdocstheme
pbr
setuptools
sphinxHook
];
propagatedBuildInputs = [
sphinxBuilders = [ "man" ];
dependencies = [
six
wrapt
];
@@ -11,12 +11,14 @@
keystoneauth1,
munch,
netifaces,
openstackdocstheme,
os-service-types,
pbr,
pythonOlder,
pyyaml,
requestsexceptions,
setuptools,
sphinxHook,
}:
buildPythonPackage rec {
@@ -26,12 +28,29 @@ buildPythonPackage rec {
disabled = pythonOlder "3.7";
outputs = [
"out"
"man"
];
src = fetchPypi {
inherit pname version;
hash = "sha256-BghpDKN8pzMnsPo3YdF+ZTlb43/yALhzXY8kJ3tPSYA=";
};
build-system = [ setuptools ];
postPatch = ''
# Disable rsvgconverter not needed to build manpage
substituteInPlace doc/source/conf.py \
--replace-fail "'sphinxcontrib.rsvgconverter'," "#'sphinxcontrib.rsvgconverter',"
'';
build-system = [
openstackdocstheme
setuptools
sphinxHook
];
sphinxBuilders = [ "man" ];
dependencies = [
platformdirs
@@ -4,6 +4,7 @@
cliff,
fetchFromGitea,
keystoneauth1,
openstackdocstheme,
oslo-i18n,
oslo-serialization,
oslo-utils,
@@ -12,6 +13,8 @@
requests-mock,
requests,
setuptools,
sphinxcontrib-apidoc,
sphinxHook,
stestr,
}:
@@ -32,11 +35,22 @@ buildPythonPackage rec {
env.PBR_VERSION = version;
postPatch = ''
# Disable rsvgconverter not needed to build manpage
substituteInPlace doc/source/conf.py \
--replace-fail "'sphinxcontrib.rsvgconverter'," "#'sphinxcontrib.rsvgconverter',"
'';
build-system = [
openstackdocstheme
pbr
setuptools
sphinxHook
sphinxcontrib-apidoc
];
sphinxBuilders = [ "man" ];
dependencies = [
cliff
keystoneauth1
@@ -65,6 +79,7 @@ buildPythonPackage rec {
homepage = "https://opendev.org/openstack/python-barbicanclient";
description = "Client library for OpenStack Barbican API";
license = lib.licenses.asl20;
mainProgram = "barbican";
maintainers = lib.teams.openstack.members;
};
}
@@ -5,6 +5,7 @@
fetchFromGitea,
jsonschema,
keystoneauth1,
openstackdocstheme,
osc-lib,
oslo-serialization,
oslo-utils,
@@ -14,6 +15,8 @@
requests-mock,
requests,
setuptools,
sphinxHook,
sphinxcontrib-apidoc,
stestr,
}:
@@ -35,10 +38,15 @@ buildPythonPackage rec {
env.PBR_VERSION = version;
build-system = [
openstackdocstheme
pbr
setuptools
sphinxHook
sphinxcontrib-apidoc
];
sphinxBuilders = [ "man" ];
dependencies = [
debtcollector
jsonschema
@@ -5,6 +5,7 @@
fetchPypi,
iso8601,
keystoneauth1,
openstackdocstheme,
osc-lib,
oslo-i18n,
oslo-serialization,
@@ -16,6 +17,8 @@
pyyaml,
requests,
requests-mock,
setuptools,
sphinxHook,
stestr,
testscenarios,
}:
@@ -23,7 +26,7 @@
buildPythonPackage rec {
pname = "python-heatclient";
version = "3.5.0";
format = "setuptools";
pyproject = true;
disabled = pythonOlder "3.8";
@@ -32,7 +35,15 @@ buildPythonPackage rec {
hash = "sha256-B1F40HYHFF91mkxwySR/kqCvlwLLtBgqwUvw2byOc9g=";
};
propagatedBuildInputs = [
build-system = [
openstackdocstheme
setuptools
sphinxHook
];
sphinxBuilders = [ "man" ];
dependencies = [
cliff
iso8601
keystoneauth1
@@ -54,10 +65,14 @@ buildPythonPackage rec {
];
checkPhase = ''
runHook preCheck
stestr run -e <(echo "
heatclient.tests.unit.test_common_http.HttpClientTest.test_get_system_ca_file
heatclient.tests.unit.test_deployment_utils.TempURLSignalTest.test_create_temp_url
")
runHook postCheck
'';
pythonImportsCheck = [ "heatclient" ];
@@ -6,6 +6,7 @@
dogpile-cache,
jsonschema,
keystoneauth1,
openstackdocstheme,
openstacksdk,
osc-lib,
oslo-utils,
@@ -15,6 +16,9 @@
pyyaml,
requests,
requests-mock,
setuptools,
sphinxcontrib-apidoc,
sphinxHook,
stestr,
stevedore,
}:
@@ -22,14 +26,23 @@
buildPythonPackage rec {
pname = "python-ironicclient";
version = "5.7.0";
format = "setuptools";
pyproject = true;
src = fetchPypi {
inherit pname version;
hash = "sha256-Blx0pr73uZA8eHd2iZ9WY+aozBFWsQhWpxoQKtjtJSk=";
};
propagatedBuildInputs = [
build-system = [
openstackdocstheme
setuptools
sphinxcontrib-apidoc
sphinxHook
];
sphinxBuilders = [ "man" ];
dependencies = [
cliff
dogpile-cache
jsonschema
@@ -51,7 +64,9 @@ buildPythonPackage rec {
];
checkPhase = ''
runHook preCheck
stestr run
runHook postCheck
'';
pythonImportsCheck = [ "ironicclient" ];
@@ -2,7 +2,6 @@
lib,
buildPythonPackage,
fetchPypi,
installShellFiles,
pbr,
openstackdocstheme,
oslo-config,
@@ -12,7 +11,8 @@
prettytable,
requests,
simplejson,
sphinx,
setuptools,
sphinxHook,
sphinxcontrib-programoutput,
babel,
osc-lib,
@@ -24,21 +24,23 @@
buildPythonPackage rec {
pname = "python-manilaclient";
version = "4.9.1";
format = "setuptools";
pyproject = true;
src = fetchPypi {
inherit pname version;
hash = "sha256-TebykdG0fkeC+5Vs9eiwuJpXam41gg8gR4F2poYKDhI=";
};
nativeBuildInputs = [
installShellFiles
build-system = [
openstackdocstheme
sphinx
setuptools
sphinxHook
sphinxcontrib-programoutput
];
propagatedBuildInputs = [
sphinxBuilders = [ "man" ];
dependencies = [
pbr
oslo-config
oslo-log
@@ -53,12 +55,6 @@ buildPythonPackage rec {
debtcollector
];
postInstall = ''
export PATH=$out/bin:$PATH
sphinx-build -a -E -d doc/build/doctrees -b man doc/source doc/build/man
installManPage doc/build/man/python-manilaclient.1
'';
# Checks moved to 'passthru.tests' to workaround infinite recursion
doCheck = false;
@@ -3,7 +3,6 @@
buildPythonPackage,
fetchPypi,
ddt,
installShellFiles,
openstackdocstheme,
osc-lib,
pbr,
@@ -11,7 +10,8 @@
python-keystoneclient,
python-novaclient,
requests-mock,
sphinx,
setuptools,
sphinxHook,
sphinxcontrib-apidoc,
stestr,
}:
@@ -19,21 +19,23 @@
buildPythonPackage rec {
pname = "python-openstackclient";
version = "6.6.0";
format = "setuptools";
pyproject = true;
src = fetchPypi {
inherit pname version;
hash = "sha256-u+8e00gpxBBSsuyiZIDinKH3K+BY0UMNpTQexExPKVw=";
};
nativeBuildInputs = [
installShellFiles
build-system = [
openstackdocstheme
sphinx
setuptools
sphinxHook
sphinxcontrib-apidoc
];
propagatedBuildInputs = [
sphinxBuilders = [ "man" ];
dependencies = [
osc-lib
pbr
python-cinderclient
@@ -41,11 +43,6 @@ buildPythonPackage rec {
python-novaclient
];
postInstall = ''
sphinx-build -a -E -d doc/build/doctrees -b man doc/source doc/build/man
installManPage doc/build/man/openstack.1
'';
nativeCheckInputs = [
ddt
stestr
@@ -53,7 +50,9 @@ buildPythonPackage rec {
];
checkPhase = ''
runHook preCheck
stestr run
runHook postCheck
'';
pythonImportsCheck = [ "openstackclient" ];
@@ -42,6 +42,8 @@ buildPythonPackage rec {
hash = "sha256-l4qKbTfQRWiRsoHN9fiAAiGMGP+q3gwRH1pMSXV/eSU=";
};
pythonRelaxDeps = [ "defusedxml" ];
nativeBuildInputs = [ setuptools ];
propagatedBuildInputs = [