diff --git a/docs/README.rst b/docs/README.rst --- a/docs/README.rst +++ b/docs/README.rst @@ -52,10 +52,10 @@ - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send deposits to SWH. These tools are provided with this repository. -See the :ref:`user-manual` page for more details on how to use the deposit client +See the :ref:`deposit-user-manual` page for more details on how to use the deposit client command line tools to push a deposit in the SWH Archive. -See the :ref:`swh-api-specifications` reference pages of the SWORDv2 API implementation +See the :ref:`deposit-api-specifications` reference pages of the SWORDv2 API implementation in `swh.deposit` if you want to do upload deposits using HTTP requests. Read the :ref:`metadata` chapter to get more details on what metadata are supported when diff --git a/docs/api/api-documentation.rst b/docs/api/api-documentation.rst --- a/docs/api/api-documentation.rst +++ b/docs/api/api-documentation.rst @@ -1,4 +1,4 @@ -.. _swh-api-specifications: +.. _deposit-api-specifications: API Documentation ================= diff --git a/docs/api/use-cases.rst b/docs/api/use-cases.rst --- a/docs/api/use-cases.rst +++ b/docs/api/use-cases.rst @@ -1,3 +1,5 @@ +.. _deposit-use-cases: + Use cases ========= diff --git a/docs/api/user-manual.rst b/docs/api/user-manual.rst --- a/docs/api/user-manual.rst +++ b/docs/api/user-manual.rst @@ -1,4 +1,4 @@ -.. _user-manual: +.. _deposit-user-manual: User Manual =========== diff --git a/docs/metadata.rst b/docs/metadata.rst new file mode 100644 --- /dev/null +++ b/docs/metadata.rst @@ -0,0 +1,4 @@ +:orphan: + +This page was moved to: :ref:`deposit-metadata`. + diff --git a/docs/spec-api.rst b/docs/spec-api.rst new file mode 100644 --- /dev/null +++ b/docs/spec-api.rst @@ -0,0 +1,3 @@ +:orphan: + +This page was moved to: :ref:`deposit-api-specifications`. diff --git a/docs/specs/blueprint.rst b/docs/specs/blueprint.rst new file mode 100644 --- /dev/null +++ b/docs/specs/blueprint.rst @@ -0,0 +1,3 @@ +:orphan: + +This page was moved to: :ref:`deposit-use-cases` diff --git a/docs/user-manual.rst b/docs/user-manual.rst new file mode 100644 --- /dev/null +++ b/docs/user-manual.rst @@ -0,0 +1,4 @@ +:orphan: + +This page was moved to: :ref:`deposit-user-manual` +