Mercurial > libervia-backend

diff doc/conf.py @ 3951:4b8776eb6826

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling: fix 380
author Goffi <goffi@goffi.org>
date Sat, 15 Oct 2022 20:38:33 +0200
parents 62e81b1058f8
children 9f85369294f3
line wrap: on
line diff
--- a/doc/conf.py	Sat Oct 15 20:38:33 2022 +0200
+++ b/doc/conf.py	Sat Oct 15 20:38:33 2022 +0200
@@ -41,6 +41,14 @@
 
 # -- General configuration ---------------------------------------------------
 
+
+rst_prolog = """
+.. |e2e_arg| replace::
+  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.
+"""
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #
 # needs_sphinx = '1.0'