diff --git a/docs/cli.rst b/docs/cli.rst new file mode 100644 index 0000000..c1d81be --- /dev/null +++ b/docs/cli.rst @@ -0,0 +1,8 @@ +.. _swh-search-cli: + +Command-line interface +====================== + +.. click:: swh.search.cli:search_cli_group + :prog: swh search + :nested: full diff --git a/docs/index.rst b/docs/index.rst index b7cb998..7c7c8bc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,26 +1,27 @@ .. _swh-search: Software Heritage - search service ================================== The SWH search service, or swh-search, stores a partial copy of the |swh| archive. It is similar to swh-storage in what it contains, but provides different ways to query it: while swh-storage is mostly a key-value store that returns an object from a primary key, swh-search is focused on reverse indices, to allow finding objects that match some criteria; for example full-text search. .. toctree:: :maxdepth: 2 :caption: Contents: + cli Reference Documentation ----------------------- .. toctree:: :maxdepth: 2 /apidoc/swh.search