[
https://issues.apache.org/jira/browse/AVRO-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17306947#comment-17306947
]
ASF subversion and git services commented on AVRO-3006:
-------------------------------------------------------
Commit 42822886c28ea74a744abb7e7a80a942c540faa5 in avro's branch
refs/heads/master from Subhash Bhushan
[ https://gitbox.apache.org/repos/asf?p=avro.git;h=4282288 ]
AVRO-3006: Fix issue with parsing documentation on PyPi (#1152)
The content in README.md is interpreted as Restructured Text by default, so PyPi
displays documentation in raw format without parsing markdown. This PR adds the
config attribute `long_description_content_type` in `setup.cfg` to tell Pypi to
parse the file content as markdown.
Refer:
https://packaging.python.org/guides/making-a-pypi-friendly-readme/#including-your-readme-in-your-package-s-metadata
The README.md file needs to be present in the same folder as setup.py, so moving
the file `lang/py/avro/README.md` one folder up.
Refer:
https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#specifying-values
> Update documentation on pypi
> ----------------------------
>
> Key: AVRO-3006
> URL: https://issues.apache.org/jira/browse/AVRO-3006
> Project: Apache Avro
> Issue Type: Improvement
> Components: python
> Affects Versions: 1.11.0
> Reporter: Michael A. Smith
> Assignee: Michael A. Smith
> Priority: Major
> Fix For: 1.11.0
>
>
> The avro python packages have outdated or missing documentation at
> https://pypi.org/project/avro-python3/ (which should state that this package
> is deprecated in favor of…)
> https://pypi.org/project/avro/ (which should have a document describing the
> package and should correctly state which version of Python it supports)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
