diff --git a/README.md b/README.md
deleted file mode 100644
index cc96358..0000000
--- a/README.md
+++ /dev/null
@@ -1,8 +0,0 @@
-swh-graph --- Software Heritage graph service
-=============================================
-
-Service providing fast access to the graph representation of the Software
-Heritage archive.
-
-The service is in-memory, based on a compressed representation of the Software
-Heritage Merkle DAG.
diff --git a/README.rst b/README.rst
new file mode 120000
index 0000000..cffceba
--- /dev/null
+++ b/README.rst
@@ -0,0 +1 @@
+docs/README.rst
\ No newline at end of file
diff --git a/docs/index.rst b/docs/README.rst
similarity index 57%
copy from docs/index.rst
copy to docs/README.rst
index e9a95b4..2d20c3d 100644
--- a/docs/index.rst
+++ b/docs/README.rst
@@ -1,43 +1,30 @@
-.. _swh-graph:
-
Software Heritage - graph service
=================================
Tooling and services, collectively known as ``swh-graph``, providing fast
-access to the graph representation of the Software Heritage archive. The
-service is in-memory, based on a compressed representation of the Software
-Heritage Merkle DAG (see :ref:`data-model`).
+access to the graph representation of the `Software Heritage
+`_
+`archive `_. The service is in-memory,
+based on a compressed representation of the Software Heritage Merkle DAG.
Bibliography
------------
-In addition to this technical documentation, ``swh-graph`` is also described in
-the following scientific paper. If you publish results based on ``swh-graph``,
-please acknowledge it by citing the paper as follows:
+In addition to accompanying technical documentation, ``swh-graph`` is also
+described in the following scientific paper. If you publish results based on
+``swh-graph``, please acknowledge it by citing the paper as follows:
.. note::
Paolo Boldi, Antoine Pietri, Sebastiano Vigna, Stefano Zacchiroli.
`Ultra-Large-Scale Repository Analysis via Graph Compression
`_. In
proceedings of `SANER 2020 `_: The 27th IEEE
International Conference on Software Analysis, Evolution and
Reengineering. IEEE 2020.
Links: `preprint
`_,
`bibtex
`_.
-
-
-.. toctree::
- :maxdepth: 1
- :caption: Overview
-
- compression
- api
- use-cases
- docker
- git2graph
- /apidoc/swh.graph
diff --git a/docs/index.rst b/docs/index.rst
index e9a95b4..6df8787 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,43 +1,15 @@
.. _swh-graph:
-Software Heritage - graph service
-=================================
-
-Tooling and services, collectively known as ``swh-graph``, providing fast
-access to the graph representation of the Software Heritage archive. The
-service is in-memory, based on a compressed representation of the Software
-Heritage Merkle DAG (see :ref:`data-model`).
-
-
-Bibliography
-------------
-
-In addition to this technical documentation, ``swh-graph`` is also described in
-the following scientific paper. If you publish results based on ``swh-graph``,
-please acknowledge it by citing the paper as follows:
-
-.. note::
-
- Paolo Boldi, Antoine Pietri, Sebastiano Vigna, Stefano Zacchiroli.
- `Ultra-Large-Scale Repository Analysis via Graph Compression
- `_. In
- proceedings of `SANER 2020 `_: The 27th IEEE
- International Conference on Software Analysis, Evolution and
- Reengineering. IEEE 2020.
-
- Links: `preprint
- `_,
- `bibtex
- `_.
+.. include:: README.rst
.. toctree::
:maxdepth: 1
:caption: Overview
compression
api
use-cases
docker
git2graph
/apidoc/swh.graph
diff --git a/setup.py b/setup.py
index 4cab260..f752222 100755
--- a/setup.py
+++ b/setup.py
@@ -1,75 +1,75 @@
#!/usr/bin/env python3
# Copyright (C) 2015-2019 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 setuptools import setup, find_packages
from os import path
from io import open
from glob import glob
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
JAR_PATHS = list(glob('java/target/swh-graph-*.jar'))
setup(
name='swh.graph',
description='Software Heritage graph service',
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/diffusion/DGRPH',
packages=find_packages(),
install_requires=parse_requirements() + parse_requirements('swh'),
tests_require=parse_requirements('test'),
setup_requires=['vcversioner'],
extras_require={'testing': parse_requirements('test')},
vcversioner={},
include_package_data=True,
data_files=[('share/swh-graph', JAR_PATHS)],
entry_points='''
[console_scripts]
swh-graph=swh.graph.cli:main
[swh.cli.subcommands]
graph=swh.graph.cli:cli
''',
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-graph',
},
)