Mercurial > libervia-backend
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 3965:2695dafc5c4d | 3966:9f85369294f3 |
|---|---|
| 45 rst_prolog = """ | 45 rst_prolog = """ |
| 46 .. |e2e_arg| replace:: | 46 .. |e2e_arg| replace:: |
| 47 To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and | 47 To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and |
| 48 share secrets with :ref:`libervia-cli_pubsub_secret`. Please read | 48 share secrets with :ref:`libervia-cli_pubsub_secret`. Please read |
| 49 :ref:`pubsub-encryption` for more details. | 49 :ref:`pubsub-encryption` for more details. |
| 50 | |
| 51 .. |sign_arg| replace:: | |
| 52 To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way | |
| 53 to remember the short option is to think of a cross made as a signature on a document). | |
| 54 Signature can then be checked with :ref:`libervia-cli_pubsub_signature`. Please read | |
| 55 :ref:`pubsub-encryption` for more details. | |
| 56 | |
| 50 """ | 57 """ |
| 51 | 58 |
| 52 # If your documentation needs a minimal Sphinx version, state it here. | 59 # If your documentation needs a minimal Sphinx version, state it here. |
| 53 # | 60 # |
| 54 # needs_sphinx = '1.0' | 61 # needs_sphinx = '1.0' |