diff --git a/README.md b/README.md deleted file mode 100644 index b26dd55..0000000 --- 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 index 0000000..03309c3 --- /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 index 0000000..89a0106 --- /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 index 831adcc..5f4e4bd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,18 +1,12 @@ -.. _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 representation. .. toctree:: :maxdepth: 2 :caption: Contents: :titlesonly: graph/index diff --git a/setup.py b/setup.py index 977e697..52ea135 100755 --- a/setup.py +++ b/setup.py @@ -1,70 +1,70 @@ #!/usr/bin/env python3 # Copyright (C) 2015-2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information from io import open from os import path 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() def parse_requirements(name=None): if name: reqf = "requirements-%s.txt" % name else: reqf = "requirements.txt" requirements = [] if not path.exists(reqf): return requirements with open(reqf) as f: for line in f.readlines(): line = line.strip() if not line or line.startswith("#"): continue requirements.append(line) return requirements setup( 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/", packages=find_packages(), # packages's modules install_requires=parse_requirements() + parse_requirements("swh"), tests_require=parse_requirements("test"), entry_points=""" [swh.cli.subcommands] dataset=swh.dataset.cli """, setup_requires=["setuptools-scm"], extras_require={"testing": parse_requirements("test")}, use_scm_version=True, include_package_data=True, classifiers=[ "Programming Language :: Python :: 3", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Development Status :: 3 - Alpha", ], project_urls={ "Bug Reports": "https://forge.softwareheritage.org/maniphest", "Funding": "https://www.softwareheritage.org/donate", "Source": "https://forge.softwareheritage.org/source/swh-dataset", "Documentation": "https://docs.softwareheritage.org/devel/swh-dataset/", }, )