From 60ca64937fb9408838220279fdf41a4e73c6d6e8 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 7 Nov 2024 16:23:58 +0000 Subject: [PATCH] Apply suggestions from code review --- doc/usage/extensions/autosummary.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/usage/extensions/autosummary.rst b/doc/usage/extensions/autosummary.rst index 23b8028ce5d..0b2b0c69cf8 100644 --- a/doc/usage/extensions/autosummary.rst +++ b/doc/usage/extensions/autosummary.rst @@ -81,16 +81,20 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts: directory. If no argument is given, output is placed in the same directory as the file that contains the directive. + .. versionadded:: 0.6 + .. rst:directive:option:: caption: caption of ToC Add a caption to the toctree. .. versionadded:: 3.1 - .. rst:directive:option:: no-signatures + .. rst:directive:option:: nosignatures Do not show function signatures in the summary. + .. versionadded:: 0.6 + .. rst:directive:option:: template: filename Specify a custom template for rendering the summary.