Structure (rinoh.structure
)¶
Sections¶
-
class rinoh.structure.Section(flowables, align=
None
, width=None
, id=None
, style=None
, parent=None
, source=None
)¶ A subdivision of a document
A section usually has a heading associated with it, which is optionally numbered.
-
class rinoh.structure.Heading(content, custom_label=
None
, align=None
, width=None
, id=None
, style=None
, parent=None
, source=None
)¶ The title for a section
- Parameters:¶
- content : StyledText¶
this heading’s text
- style_class¶
alias of
HeadingStyle
- prepare(container)¶
Determine number labels and register references with the document
-
flow(container, last_descender, state=
None
, **kwargs)¶ Flow this flowable into container and return the vertical space consumed.
The flowable’s contents are preceded by a vertical space with a height as specified in its style’s space_above attribute. Similarly, the flowed content is followed by a vertical space with a height given by the space_below style attribute.
- class rinoh.structure.SectionTitles(**strings)¶
Collection of localized titles for common sections
Lists¶
-
class rinoh.structure.List(list_items, start_index=
1
, id=None
, style=None
, parent=None
)¶
-
class rinoh.structure.DefinitionList(flowables, align=
None
, width=None
, id=None
, style=None
, parent=None
, source=None
)¶
Table of Contents¶
- class rinoh.structure.TableOfContentsSection¶
-
class rinoh.structure.TableOfContents(local=
False
, id=None
, style=None
, parent=None
)¶ - style_class¶
alias of
TableOfContentsStyle
- flowables(container)¶
Generator yielding the
Flowable
s to group
-
class rinoh.structure.TableOfContentsEntry(flowable, id=
None
, style=None
, parent=None
)¶ - style_class¶
alias of
TableOfContentsEntryStyle
Adminitions¶
-
class rinoh.structure.Admonition(flowables, title=
None
, type=None
, id=None
, style=None
, parent=None
)¶ - style_class¶
alias of
AdmonitionStyle
- flowables(container)¶
Generator yielding the
Flowable
s to group
- class rinoh.structure.AdmonitionTitles(**strings)¶
Collection of localized titles for common admonitions
Horizontal Rule¶
-
class rinoh.structure.HorizontalRule(align=
None
, width=None
, id=None
, style=None
, parent=None
, source=None
)¶ - style_class¶
alias of
HorizontalRuleStyle
- render(container, descender, state, **kwargs)¶
Renders the flowable’s content to container, with the flowable’s top edge lining up with the container’s cursor. descender is the descender height of the preceding line or None.