Include README.rst in the documentation.

README.md → README.rst

-swh-core
-========
+.. _swh-core:
+
+Software Heritage - Core foundations
+====================================
+
+Low-level utilities and helpers used by almost all other modules in the stack.
 
 core library for swh's modules:
+
 - config parser
 - hash computations
 - serialization

docs/README.rst

+../README.rst
\ No newline at end of file

docs/index.rst

-.. _swh-core:
-
-Software Heritage - Core foundations
-====================================
-
-Low-level utilities and helpers used by almost all other modules in the stack.
-
+.. include:: README.rst
 
 Reference Documentation
 -----------------------

setup.py

@@ -13,7 +13,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()
 
 
@@ -41,7 +41,7 @@ setup(
     name="swh.core",
     description="Software Heritage core utilities",
     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",