diff --git a/README.md b/README.md deleted file mode 100644 --- a/README.md +++ /dev/null @@ -1,6 +0,0 @@ -swh-dataset -=========== - -Public datasets produced and released by `Software Heritage`_. - -.. _Software Heritage: https://www.softwareheritage.org diff --git a/README.rst b/README.rst new file mode 100644 --- /dev/null +++ b/README.rst @@ -0,0 +1,9 @@ +.. _swh-dataset: + +Software Heritage Datasets +========================== + +This page lists the different public datasets and periodic data dumps of the +archive produced and released by `Software Heritage`_. + +.. _Software Heritage: https://www.softwareheritage.org diff --git a/docs/README.rst b/docs/README.rst new file mode 120000 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,4 @@ -.. _swh-dataset: - -Software Heritage Datasets -========================== - -This page lists the different public datasets and periodic data dumps of the -archive published by Software Heritage. +.. include:: README.rst :ref:`The Software Heritage Graph Dataset ` the entire graph of Software Heritage in a fully-deduplicated Merkle DAG diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ 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 @@ name="swh.dataset", description="Software Heritage dataset tools", long_description=long_description, - long_description_content_type="text/markdown", + long_description_content_type="text/x-rst", author="Software Heritage developers", author_email="swh-devel@inria.fr", url="https://forge.softwareheritage.org/source/swh-dataset/",