Skip to content

Commit 1405b4d

Browse files
committed
docs: document ChoicesChildren
1 parent b212465 commit 1405b4d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

quartodoc/layout.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,20 @@ class Text(_Docable):
161161

162162

163163
class ChoicesChildren(Enum):
164+
"""Options for how child members of a class or module should be documented.
165+
166+
Attributes
167+
----------
168+
embedded:
169+
Embed documentation inside the parent object's documentation.
170+
flat:
171+
Include documentation after the parent object's documentation.
172+
separate:
173+
Put documentation for members on their own, separate pages.
174+
linked:
175+
Include only a table of links to members (which may not be documented).
176+
"""
177+
164178
embedded = "embedded"
165179
flat = "flat"
166180
separate = "separate"

0 commit comments

Comments
 (0)