Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
Show First 20 Lines • Show All 46 Lines • ▼ Show 20 Lines | |||||
- a deposited artifact has a codemeta_ metadata entry attached to it, | - a deposited artifact has a codemeta_ metadata entry attached to it, | ||||
- a deposited artifact has the same visibility on the SWH Archive than a | - a deposited artifact has the same visibility on the SWH Archive than a | ||||
collected repository, | collected repository, | ||||
- a deposited artifacts can be searched with its provided url property on the | - a deposited artifacts can be searched with its provided url property on the | ||||
SWH Archive, | SWH Archive, | ||||
- the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send | - the deposit API uses the `SWORD v2`_ API, thus requires some tooling to send | ||||
deposits to SWH. These tools are provided with this repository. | deposits to SWH. These tools are provided with this repository. | ||||
See the :ref:`getting-started` page for more details on how to use the deposit | |||||
See the :ref:`user-manual` page for more details on how to use the deposit | |||||
client tools to push a deposit in the SWH Archive. | client tools to push a deposit in the SWH Archive. | ||||
.. _codemeta: https://codemeta.github.io/ | .. _codemeta: https://codemeta.github.io/ | ||||
.. _`SWORD v2`: http://swordapp.org/sword-v2/ | .. _`SWORD v2`: http://swordapp.org/sword-v2/ | ||||
.. toctree:: | .. toctree:: | ||||
:maxdepth: 2 | :maxdepth: 2 | ||||
:caption: Contents: | :caption: Contents: | ||||
getting-started | user-manual | ||||
spec-api | spec-api | ||||
metadata | metadata | ||||
dev-info | dev-info | ||||
sys-info | sys-info | ||||
specs/index | specs/index | ||||
tests/tests_HAL.rst | tests/tests_HAL.rst | ||||
Reference Documentation | Reference Documentation | ||||
----------------------- | ----------------------- | ||||
.. toctree:: | .. toctree:: | ||||
:maxdepth: 2 | :maxdepth: 2 | ||||
/apidoc/swh.deposit | /apidoc/swh.deposit |