docs: include the README file in the main index page

Convert README from markdown to ReST to make it embeddable in
docs/index.rst
This commit is contained in:
David Douard 2023-11-16 13:44:04 +01:00
parent a9b2980f14
commit 553884fa56
4 changed files with 125 additions and 117 deletions

View file

@ -12,7 +12,7 @@ from setuptools import find_packages, setup
here = path.abspath(path.dirname(__file__))
# Get the long description from the README file
with open(path.join(here, "README.md"), encoding="utf-8") as f:
with open(path.join(here, "README.rst"), encoding="utf-8") as f:
long_description = f.read()
@ -39,7 +39,7 @@ setup(
name="swh.lister",
description="Software Heritage lister",
long_description=long_description,
long_description_content_type="text/markdown",
long_description_content_type="text/x-rst",
python_requires=">=3.7",
author="Software Heritage developers",
author_email="swh-devel@inria.fr",