File tree Expand file tree Collapse file tree 1 file changed +4
-1
lines changed
Expand file tree Collapse file tree 1 file changed +4
-1
lines changed Original file line number Diff line number Diff line change @@ -469,13 +469,16 @@ plugins:
469469[](){#option-show_category_heading}
470470# # `show_category_heading`
471471
472- - **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
472+ - **:octicons-package-24: Type [`str| bool`][] :material-equal: `False`{ title="default value" }**
473473<!-- - **:octicons-project-template-24 : Template :material-null:** (N/A) -->
474474
475475When [grouped by categories][group_by_category], show a heading for each category.
476476These category headings will appear in the table of contents,
477477allowing you to link to them using their permalinks.
478478
479+ ` show_category_heading` can be enabled selectively for individual object types by specifying either `mod` or `class`.
480+ When specified, category headings will only be shown for the chosen type.
481+
479482WARNING : **Not recommended with deeply nested objects.**
480483When injecting documentation for deeply nested objects,
481484you'll quickly run out of heading levels, and the objects
You can’t perform that action at this time.
0 commit comments