layout.Section
layout.Section(self, **data)
A section of content on the reference index page.
Attributes
Name | Type | Description |
---|---|---|
kind | Literal[‘section’] | |
title | Optional[str] | Title of the section on the index. |
subtitle | Optional[str] | Subtitle of the section on the index. Note that either title or subtitle, but not both, may be set. |
desc | Optional[str] | Description of the section on the index. |
package | Union[str, None, MISSING ] |
If specified, all object lookups will be relative to this path. |
contents | ContentList |
Individual objects (e.g. functions, classes, methods) being documented. |