From 100eb6ddc7cee18268743fbe28396dd493377d85 Mon Sep 17 00:00:00 2001 From: Antoine Pietri <antoine.pietri1@gmail.com> Date: Tue, 3 Sep 2019 16:41:35 +0200 Subject: [PATCH] docs: link pages together from a TOC --- docs/data-model.rst | 2 -- docs/index.rst | 16 ++++------------ docs/persistent-identifiers.rst | 6 ++++-- 3 files changed, 8 insertions(+), 16 deletions(-) diff --git a/docs/data-model.rst b/docs/data-model.rst index e531b1a6..fc1639d3 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 c1c3079d..19e075e8 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 cc194215..ee6b49c6 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 -- GitLab