Skip to content

prettyqtmarkdown

Docs

Module containing stuff to help buidling docs.

This module builds on mknodes and contains some new nodes to help building documentation, an MkItemModelTable to easily display Qt ItemModels as Markdown Tables as well as a model + widget to preview a generated mknodes tree.

Classes

Name Children Inherits
MarkdownWidget
prettyqt.prettyqtmarkdown.markdownwidget
MkItemModelTable
prettyqt.prettyqtmarkdown.mkitemmodeltable
Table which can display Qt ItemModels.
MarkdownModel
prettyqt.prettyqtmarkdown.markdownmodel
QtLinkProvider
prettyqt.prettyqtmarkdown.qtlinkprovider
MkPropertyTable
prettyqt.prettyqtmarkdown.mkpropertytable
A table containing info about Qt properties.
MkPrettyQtDiagram
prettyqt.prettyqtmarkdown.mkprettyqtdiagram
MkWidgetScreenShot
prettyqt.prettyqtmarkdown.mkwidgetscreenshot
Node to easily create and embed a widget screenshot into docs.
MkPrettyQtClassPage
prettyqt.prettyqtmarkdown.mkprettyqtclasspage
A ClassPage specifically for Qt-based classes.