mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 09:00:00 -06:00
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:
1 parent
e65bbb96ae
commit
432bc5e50b
3 files changed
+16
-1
No files matched your search
@@ -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
|
||||
|
||||
Reference in new issue
Block a user