diff --git a/docs/index.rst b/docs/index.rst index d1daf3e..e9a95b4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,19 +1,43 @@ .. _swh-graph: Software Heritage - graph service ================================= -Tooling and 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 (see :ref:`data-model`). +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 + `_. + .. toctree:: :maxdepth: 1 :caption: Overview compression api use-cases docker git2graph /apidoc/swh.graph