Specify that the long description is rST in the package metadata. (#9180)

This avoids a warning when uploading packages to PyPI via twine.
2024-12-25 08:59:31 -05:00 · 2021-01-20 16:00:59 -05:00 · 2021-01-20 16:00:59 -05:00 · 1fa15b74e0
commit 1fa15b74e0
parent 818bf313bc
2 changed files with 2 additions and 0 deletions
--- a/changelog.d/9180.misc
+++ b/changelog.d/9180.misc
@ -0,0 +1 @@
+Add a `long_description_type` to the package metadata.
--- a/setup.py
+++ b/setup.py
@ -121,6 +121,7 @@ setup(
    include_package_data=True,
    zip_safe=False,
    long_description=long_description,
+    long_description_content_type="text/x-rst",
    python_requires="~=3.5",
    classifiers=[
        "Development Status :: 5 - Production/Stable",
				`@ -0,0 +1 @@`
				Add a `long_description_type` to the package metadata.