Mercurial > libervia-backend
diff doc/conf.py @ 3966:9f85369294f3
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
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 30 Oct 2022 01:06:58 +0200 |
| parents | 4b8776eb6826 |
| children | c4418949aa37 |
line wrap: on
line diff
--- a/doc/conf.py Sun Oct 30 01:06:58 2022 +0200 +++ b/doc/conf.py Sun Oct 30 01:06:58 2022 +0200 @@ -47,6 +47,13 @@ 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.