Skip to content

Commit 760ed12

Browse files
committed
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`.
1 parent a14e5cf commit 760ed12

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ Run tests
9090
On Linux:
9191

9292
.. code-block:: console
93+
9394
$ python setup.py test
9495
9596
On Windows:

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ def find_version(*file_paths):
7272
license="BSD",
7373
description="Python client library for Tarantool 1.6 Database",
7474
long_description=read('README.rst'),
75+
long_description_content_type='text/x-rst',
7576
classifiers=[
7677
"Intended Audience :: Developers",
7778
"License :: OSI Approved :: BSD License",

0 commit comments

Comments
 (0)