From ced9f0d06b6766d13227f22064923ccf11567a28 Mon Sep 17 00:00:00 2001 From: Alexander Turenko Date: Sat, 15 Jun 2019 01:00:02 +0300 Subject: [PATCH] Fix README.rst formatting Now pypi.org discards a package that does not pass long_description validation. In our case: | The project's long_description has invalid markup which will not be | rendered on PyPI. The following syntax errors were detected: | line 92: Error: Error in "code-block" directive: | maximum 1 argument(s) allowed, 5 supplied. | | .. code-block:: console | $ python setup.py test Also added long_description_content_type to eliminate `twine check dist/*` warning: | Checking distribution dist/tarantool-0.6.6.tar.gz: warning: | `long_description_content_type` missing. defaulting to `text/x-rst`. --- README.rst | 1 + setup.py | 1 + 2 files changed, 2 insertions(+) diff --git a/README.rst b/README.rst index e0d579a4..b3c12c22 100644 --- a/README.rst +++ b/README.rst @@ -90,6 +90,7 @@ Run tests On Linux: .. code-block:: console + $ python setup.py test On Windows: diff --git a/setup.py b/setup.py index d3e12834..763872ca 100755 --- a/setup.py +++ b/setup.py @@ -72,6 +72,7 @@ def find_version(*file_paths): license="BSD", description="Python client library for Tarantool 1.6 Database", long_description=read('README.rst'), + long_description_content_type='text/x-rst', classifiers=[ "Intended Audience :: Developers", "License :: OSI Approved :: BSD License",