doc (encryption, cli): pubsub signing documentation:

- add a `Pubsub Signature` section to `encryption` documentation
- document `-X, --sign` flag where it's used
- document `pubsub/signature` subcommands

fix 381
This commit is contained in:
Goffi 2022-10-30 01:06:58 +02:00
commit 289855c9d1

View file

@ -47,6 +47,13 @@ rst_prolog = """
To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and
share secrets with :ref:`libervia-cli_pubsub_secret`. Please read
:ref:`pubsub-encryption` for more details.
.. |sign_arg| replace::
To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way
to remember the short option is to think of a cross made as a signature on a document).
Signature can then be checked with :ref:`libervia-cli_pubsub_signature`. Please read
:ref:`pubsub-encryption` for more details.
"""
# If your documentation needs a minimal Sphinx version, state it here.