From 0da13ca23aa921da09f5057cdcbf4c7b88c80fef Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Mon, 27 Jul 2020 10:06:23 -0500 Subject: [PATCH] Fix README to be proper RST syntax The README file was in RST, but had a formatting issue with the title. The usage of the README is setup was incorrectly setting the content type to markdown, rather than RST. This seems to have caused our twine check to validate the package as fine, but PyPi apparently checks package metadata a different way and rejected the package upload due to issues with the README file. This corrects the RST syntax, renames the file from txt to rst to accurately reflect its content type, and updates the settings up setup.py to correctly report the content as RST. Change-Id: I5135a709410372aa938446563e8eca70b5eea985 Signed-off-by: Sean McGinnis --- README.txt => README.rst | 3 ++- setup.py | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) rename README.txt => README.rst (90%) diff --git a/README.txt b/README.rst similarity index 90% rename from README.txt rename to README.rst index e2cf057..014a175 100644 --- a/README.txt +++ b/README.rst @@ -1,5 +1,6 @@ +======================= XStatic-Moment-Timezone --------------- +======================= Moment-Timezone JavaScript library packaged for setuptools (easy_install) / pip. diff --git a/setup.py b/setup.py index bc8cfbe..6fc264b 100644 --- a/setup.py +++ b/setup.py @@ -3,14 +3,14 @@ from xstatic.pkg import moment_timezone as xs # The README.txt file should be written in reST so that PyPI can use # it to generate your project's PyPI page. -long_description = open('README.txt').read() +long_description = open('README.rst').read() setup( name=xs.PACKAGE_NAME, version=xs.PACKAGE_VERSION, description=xs.DESCRIPTION, long_description=long_description, - long_description_content_type="text/markdown", + long_description_content_type="text/x-rst", classifiers=xs.CLASSIFIERS, keywords=xs.KEYWORDS, maintainer=xs.MAINTAINER,