Skip to content

Commit

Permalink
doc: replace deprecated distutils version parsing
Browse files Browse the repository at this point in the history
[ upstream commit 2654ce5 ]

When using Python 3.10, this warning appears:
  DeprecationWarning: The distutils package is deprecated
  and slated for removal in Python 3.12.
  Use setuptools or check PEP 632 for potential alternatives

The PEP 632 recommends replacing "distutils.version" with "packaging".

Bugzilla ID: 914

Reported-by: Jerin Jacob <jerinj@marvell.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Tested-by: Jerin Jacob <jerinj@marvell.com>
  • Loading branch information
tmonjalo authored and bluca committed Feb 14, 2022
1 parent 0b5a6c7 commit 2694894
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions buildtools/call-sphinx-build.py
Expand Up @@ -7,7 +7,7 @@
import os
from os.path import join
from subprocess import run, PIPE, STDOUT
from distutils.version import StrictVersion
from packaging.version import Version

# assign parameters to variables
(sphinx, version, src, dst, *extra_args) = sys.argv[1:]
Expand All @@ -19,7 +19,7 @@
ver = run([sphinx, '--version'], stdout=PIPE,
stderr=STDOUT).stdout.decode().split()[-1]
sphinx_cmd = [sphinx] + extra_args
if StrictVersion(ver) >= StrictVersion('1.7'):
if Version(ver) >= Version('1.7'):
sphinx_cmd += ['-j', 'auto']

# find all the files sphinx will process so we can write them as dependencies
Expand Down
6 changes: 3 additions & 3 deletions doc/guides/conf.py
Expand Up @@ -3,7 +3,7 @@
# Copyright(c) 2010-2015 Intel Corporation

from docutils import nodes
from distutils.version import LooseVersion
from packaging.version import Version
from sphinx import __version__ as sphinx_version
from os import listdir
from os import environ
Expand All @@ -28,7 +28,7 @@

project = 'Data Plane Development Kit'
html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
if LooseVersion(sphinx_version) >= LooseVersion('3.5'):
if Version(sphinx_version) >= Version('3.5'):
html_permalinks = False
else:
html_add_permalinks = ""
Expand Down Expand Up @@ -385,7 +385,7 @@ def setup(app):
'Features availability in bbdev drivers',
'Feature')

if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
if Version(sphinx_version) < Version('1.3.1'):
print('Upgrade sphinx to version >= 1.3.1 for '
'improved Figure/Table number handling.',
file=stderr)
Expand Down

0 comments on commit 2694894

Please sign in to comment.