diff --git a/docs/persistent-identifiers.rst b/docs/persistent-identifiers.rst --- a/docs/persistent-identifiers.rst +++ b/docs/persistent-identifiers.rst @@ -279,8 +279,8 @@ Identifiers with qualifiers --------------------------- -* The following `SWHID - `__ +* The following :swh_web:`SWHID + ` denotes the lines 9 to 15 of a file content that can be found at absolute path ``/Examples/SimpleFarm/simplefarm.ml`` from the root directory of the revision ``swh:1:rev:2db189928c94d62a3b4757b3eec68f0a4d4113f0`` that is @@ -295,8 +295,8 @@ path=/Examples/SimpleFarm/simplefarm.ml; lines=9-15 -* Here is an example of a `SWHID - `__ +* Here is an example of a :swh_web:`SWHID + ` with a file path that requires percent-escaping:: swh:1:cnt:f10371aa7b8ccabca8479196d6cd640676fd4a04; @@ -325,7 +325,7 @@ SWHIDs are also automatically computed by Software Heritage for all archived objects as part of its archival activity, and can be looked up via the project -`Web interface `_. +:swh_web:`Web interface <>`. This has various practical implications: @@ -345,25 +345,25 @@ Software Heritage resolver ~~~~~~~~~~~~~~~~~~~~~~~~~~ -SWHIDs can be resolved using the Software Heritage `Web interface -`_. In particular, the **root endpoint** +SWHIDs can be resolved using the Software Heritage :swh_web:`Web interface <>`. +In particular, the **root endpoint** ``/`` can be given a SWHID and will lead to the browsing page of the corresponding object, like this: ``https://archive.softwareheritage.org/``. -A **dedicated** ``/resolve`` **endpoint** of the Software Heritage `Web API -`_ is also available to +A **dedicated** ``/resolve`` **endpoint** of the Software Heritage :swh_web:`Web API +` is also available to programmatically resolve SWHIDs; see: :http:get:`/api/1/resolve/(swhid)/`. Examples: -* ``_ -* ``_ -* ``_ -* ``_ -* ``_ -* ``_ -* ``_ +* :swh_web:`` +* :swh_web:`` +* :swh_web:`` +* :swh_web:`` +* :swh_web:`` +* :swh_web:`` +* :swh_web:`` Third-party resolvers