Public
  1. Public

avro

Public

Commits

Subhash BhushanGitHub
f0ee46dbceb
Subhash Bhushan authored and GitHub committed 42822886c28
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