Add a class option to the autosummary directive (#13144)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Tim HoffmannandAdam Turner authored and GitHub committed 2025-01-04 00:28:59 +00:00
1 parent e65bbb96ae
commit 432bc5e50b
3 files changed
+16 -1

No files matched your search

+10
View File
@@ -63,6 +63,16 @@ The :mod:`sphinx.ext.autosummary` extension does this in two parts:
.. rubric:: Options
.. rst:directive:option:: class: class names
:type: a list of class names, separated by spaces
Assign `class attributes`_ to the table.
This is a :dudir:`common option <common-options>`.
.. _class attributes: https://docutils.sourceforge.io/docs/ref/doctree.html#classes
.. versionadded:: 8.2
.. rst:directive:option:: toctree: optional directory name
If you want the :rst:dir:`autosummary` table to also serve as a