From 0073c2aec49085d9a271e9d43a3c01216364c9c3 Mon Sep 17 00:00:00 2001 From: James Knight Date: Tue, 19 Mar 2024 00:10:16 -0400 Subject: [PATCH] doc: update page-gen notice config for new capabilities Signed-off-by: James Knight --- doc/configuration.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/doc/configuration.rst b/doc/configuration.rst index 00445cd7..7c38a77c 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -397,15 +397,24 @@ Generic configuration .. confval:: confluence_page_generation_notice .. versionadded:: 1.7 + .. versionchanged:: 2.5 Accept a string for custom notice. - A boolean value to whether or not to generate a message at the top of each - document that the page has been automatically generated. By default, this - notice is disabled with a value of ``False``. + This option can be set with a boolean value to whether or not to generate + a message at the top of each document that the page has been + automatically generated. .. code-block:: python confluence_page_generation_notice = True + Alternatively, users may set a custom message to display. + + .. code-block:: python + + confluence_page_generation_notice = 'My awesome message.' + + By default, this notice is disabled with a value of ``False``. + .. confval:: confluence_page_hierarchy .. versionchanged:: 2.0 Option is enabled by default.