diff --git a/docs/cli.rst b/docs/cli.rst new file mode 100644 index 00000000..74e78cc2 --- /dev/null +++ b/docs/cli.rst @@ -0,0 +1,8 @@ +.. _swh-storage-cli: + +Command-line interface +====================== + +.. click:: swh.storage.cli:storage + :prog: swh storage + :nested: full diff --git a/docs/index.rst b/docs/index.rst index 502967a3..17037bbd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,45 +1,46 @@ .. _swh-storage: Software Heritage - Storage =========================== Abstraction layer over the archive, allowing to access all stored source code artifacts as well as their metadata The Software Heritage storage consist of a high-level storage layer (:mod:`swh.storage`) that exposes a client/server API (:mod:`swh.storage.api`). The API is exposed by a server (:mod:`swh.storage.api.server`) and accessible via a client (:mod:`swh.storage.api.client`). The low-level implementation of the storage is split between an object storage (:ref:`swh.objstorage `), which stores all "blobs" (i.e., the leaves of the :ref:`data-model`) and a SQL representation of the rest of the graph (:mod:`swh.storage.storage`). Database schema --------------- * :ref:`sql-storage` Archive copies -------------- * :ref:`archive-copies` Specifications -------------- * :ref:`extrinsic-metadata-specification` Reference Documentation ----------------------- .. toctree:: :maxdepth: 2 + cli /apidoc/swh.storage