subhashb opened a new pull request #1152: URL: https://github.com/apache/avro/pull/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 Make sure you have checked _all_ steps below. ### Jira - [x] My PR addresses the following an issue with AVRO-3006 "Update Documentation on PyPi" - https://issues.apache.org/jira/browse/AVRO-3006 ### Tests - [x] My PR does not need test cases. ### Commits - [x] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://chris.beams.io/posts/git-commit/)": 1. Subject is separated from body by a blank line 1. Subject is limited to 50 characters (not including Jira issue reference) 1. Subject does not end with a period 1. Subject uses the imperative mood ("add", not "adding") 1. Body wraps at 72 characters 1. Body explains "what" and "why", not "how" ### Documentation - [x] My PR fixes displays of documentation on PyPi. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
