Skip to content

Commit

Permalink
doc: update page-gen notice config for new capabilities
Browse files Browse the repository at this point in the history
Signed-off-by: James Knight <james.d.knight@live.com>
  • Loading branch information
jdknight committed Mar 19, 2024
1 parent 4d91b29 commit 0073c2a
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0073c2a

Please sign in to comment.