Skip to content

Fix README.rst formatting#147

Merged
Totktonada merged 1 commit intomasterfrom
Totktonada/fix-readme-rst-formatting
Jun 15, 2019
Merged

Fix README.rst formatting#147
Totktonada merged 1 commit intomasterfrom
Totktonada/fix-readme-rst-formatting

Conversation

@Totktonada
Copy link
Contributor

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.

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`.
@Totktonada Totktonada merged commit 760ed12 into master Jun 15, 2019
@Totktonada Totktonada deleted the Totktonada/fix-readme-rst-formatting branch June 15, 2019 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant