diff --git a/docs/cli.rst b/docs/cli.rst new file mode 100644 index 0000000..26fc96b --- /dev/null +++ b/docs/cli.rst @@ -0,0 +1,8 @@ +.. _swh-objstorage-replayer-cli: + +Command-line interface +====================== + +.. click:: swh.objstorage.replayer.cli:content_replay + :prog: swh objstorage replay + :nested: full diff --git a/docs/index.rst b/docs/index.rst index ec7dbd1..cd5c2eb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,20 +1,21 @@ .. _swh-objstorage-replayer: Software Heritage - Object storage replayer =========================================== This Python module provides a command line tool to replicate content objects from a source Object storage to a destination one by listening the `content` topic of a `swh.journal` kafka stream. It is meant to be used as the brick of a mirror setup dedicated to replicating content objects. Reference Documentation ----------------------- .. toctree:: :maxdepth: 2 + cli /apidoc/swh.objstorage.replayer