From dcaaf56e350eac0221a4c0fc27cddb0b96aaa4ed Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Thu, 17 Aug 2023 17:16:30 +0100 Subject: [PATCH] Add release note for events support Signed-off-by: Stephen Finucane --- .../add-event-support-e55edb86d86d1082.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 releasenotes/notes/add-event-support-e55edb86d86d1082.yaml diff --git a/releasenotes/notes/add-event-support-e55edb86d86d1082.yaml b/releasenotes/notes/add-event-support-e55edb86d86d1082.yaml new file mode 100644 index 0000000..6fa92f4 --- /dev/null +++ b/releasenotes/notes/add-event-support-e55edb86d86d1082.yaml @@ -0,0 +1,17 @@ +--- +features: + - | + A number of events are now supported: + + - ``sphinx-click-process-description`` + - ``sphinx-click-process-usage`` + - ``sphinx-click-process-options`` + - ``sphinx-click-process-arguments`` + - ``sphinx-click-process-envvars`` + - ``sphinx-click-process-epilog`` + + These allow you to plug in to the build process for documentation and + post-process the generated command documentation. For more information, + refer to the `documentation`__. + + .. __: https://sphinx-click.readthedocs.io/en/latest/usage/#docstring-processing