Skip to content

Commit 28a82e6

Browse files
MrMinojonathanslenders
authored andcommitted
Reduce usage of automodule in Layout docs section
Using automodule multiple times adds the same module docstring multiple times, bugging out the TOC tree and links. Module docstring for prompt_toolkit.layout should also be put in the leading section, not under "The layout class itself". This commit fixes the above by replacing the usage of `.. automodule::` with `.. autoclass::`. The `..automodule::` clause is used only in the leading section, where the module introduction text should land.
1 parent 0d52661 commit 28a82e6

File tree

1 file changed

+86
-14
lines changed

1 file changed

+86
-14
lines changed

docs/pages/reference.rst

Lines changed: 86 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -132,45 +132,117 @@ Lexers
132132
Layout
133133
------
134134

135+
.. automodule:: prompt_toolkit.layout
136+
135137
The layout class itself
136138
^^^^^^^^^^^^^^^^^^^^^^^
137139

138-
.. automodule:: prompt_toolkit.layout
139-
:members: Layout, InvalidLayoutError, walk
140+
.. autoclass:: prompt_toolkit.layout.Layout
140141

142+
.. autoclass:: prompt_toolkit.layout.InvalidLayoutError
143+
144+
.. autoclass:: prompt_toolkit.layout.walk
141145

142146
Containers
143147
^^^^^^^^^^
144148

145-
.. automodule:: prompt_toolkit.layout
146-
:members: Container, HSplit, VSplit, FloatContainer, Float, Window,
147-
WindowAlign, ConditionalContainer, DynamicContainer, ScrollOffsets,
148-
ColorColumn, to_container, to_window, is_container, HorizontalAlign,
149-
VerticalAlign
149+
.. autoclass:: prompt_toolkit.layout.Container
150+
151+
.. autoclass:: prompt_toolkit.layout.HSplit
152+
153+
.. autoclass:: prompt_toolkit.layout.VSplit
154+
155+
.. autoclass:: prompt_toolkit.layout.FloatContainer
156+
157+
.. autoclass:: prompt_toolkit.layout.Float
158+
159+
.. autoclass:: prompt_toolkit.layout.Window
160+
161+
.. autoclass:: prompt_toolkit.layout.WindowAlign
162+
163+
.. autoclass:: prompt_toolkit.layout.ConditionalContainer
150164

165+
.. autoclass:: prompt_toolkit.layout.DynamicContainer
166+
167+
.. autoclass:: prompt_toolkit.layout.ScrollOffsets
168+
169+
.. autoclass:: prompt_toolkit.layout.ColorColumn
170+
171+
.. autoclass:: prompt_toolkit.layout.to_container
172+
173+
.. autoclass:: prompt_toolkit.layout.to_window
174+
175+
.. autoclass:: prompt_toolkit.layout.is_container
176+
177+
.. autoclass:: prompt_toolkit.layout.HorizontalAlign
178+
179+
.. autoclass:: prompt_toolkit.layout.VerticalAlign
151180

152181
Controls
153182
^^^^^^^^
154183

155-
.. automodule:: prompt_toolkit.layout
156-
:members: BufferControl, SearchBufferControl, DummyControl,
157-
FormattedTextControl, UIControl, UIContent
184+
.. autoclass:: prompt_toolkit.layout.BufferControl
185+
186+
.. autoclass:: prompt_toolkit.layout.SearchBufferControl
187+
188+
.. autoclass:: prompt_toolkit.layout.DummyControl
189+
190+
.. autoclass:: prompt_toolkit.layout.FormattedTextControl
191+
192+
.. autoclass:: prompt_toolkit.layout.UIControl
193+
194+
.. autoclass:: prompt_toolkit.layout.UIContent
158195

159196

160197
Other
161198
^^^^^
162199

163-
.. automodule:: prompt_toolkit.layout
164-
:members: Dimension, Margin, NumberedMargin, ScrollbarMargin,
165-
ConditionalMargin, PromptMargin, CompletionsMenu,
166-
MultiColumnCompletionsMenu
200+
201+
Sizing
202+
""""""
203+
204+
.. autoclass:: prompt_toolkit.layout.Dimension
205+
206+
207+
Margins
208+
"""""""
209+
210+
.. autoclass:: prompt_toolkit.layout.Margin
211+
212+
.. autoclass:: prompt_toolkit.layout.NumberedMargin
213+
214+
.. autoclass:: prompt_toolkit.layout.ScrollbarMargin
215+
216+
.. autoclass:: prompt_toolkit.layout.ConditionalMargin
217+
218+
.. autoclass:: prompt_toolkit.layout.PromptMargin
219+
220+
221+
Completion Menus
222+
""""""""""""""""
223+
224+
.. autoclass:: prompt_toolkit.layout.CompletionsMenu
225+
226+
.. autoclass:: prompt_toolkit.layout.MultiColumnCompletionsMenu
227+
228+
229+
Processors
230+
""""""""""
167231

168232
.. automodule:: prompt_toolkit.layout.processors
169233
:members:
170234

235+
236+
Utils
237+
"""""
238+
171239
.. automodule:: prompt_toolkit.layout.utils
172240
:members:
173241

242+
243+
Screen
244+
""""""
245+
174246
.. automodule:: prompt_toolkit.layout.screen
175247
:members:
176248

0 commit comments

Comments
 (0)