diff --git a/docs/data-model.rst b/docs/data-model.rst index e531b1a660aab00b0a7b39419c466f0b5593f89e..fc1639d3cac2ee1f0ab3b80bf0408b689cfd66a1 100644 --- a/docs/data-model.rst +++ b/docs/data-model.rst @@ -1,5 +1,3 @@ -:orphan: - .. _data-model: Data model diff --git a/docs/index.rst b/docs/index.rst index c1c3079dd61c5f809ebcbfc4a95a92c058d001cf..19e075e8a9e244cad612e76be3086d31c531628b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,18 +5,10 @@ Software Heritage - Data model Implementation of the :ref:`data-model` to archive source code artifacts. - -Overview --------- - -* :ref:`data-model` -* :ref:`persistent-identifiers` - - -Reference Documentation ------------------------ - .. toctree:: - :maxdepth: 2 + :caption: Overview: + :titlesonly: + data-model + persistent-identifiers /apidoc/swh.model diff --git a/docs/persistent-identifiers.rst b/docs/persistent-identifiers.rst index cc19421520b48fb6ff6bc08cd320401bdd587d12..ee6b49c6b999641ecdf537e6f08540e3775ea967 100644 --- a/docs/persistent-identifiers.rst +++ b/docs/persistent-identifiers.rst @@ -1,10 +1,12 @@ -:orphan: - .. _persistent-identifiers: +====================== Persistent identifiers ====================== +Description +=========== + You can point to objects present in the Software Heritage archive by the means of **persistent identifiers** that are guaranteed to remain stable (persistent) over time. Their syntax, meaning, and usage is described below. Note that they