MkClassPage

An MkClassPage is an MkPage subclass used to display information about a specific class. It uses a Jinja template to display the class-related information. By default, the Docstrings, tables for sub and parent classes as well as an inheritance graph are shown. The template can be adjusted manually in case a different layout is preferred.

This is an example for an MkClassPage with the default layout:

--- created: source_filename: /home/runner/work/mknodes/mknodes/src/mknodes/pages/mkclasspage/__init__.py source_function: MkClassPage.__init__ source_line_no: 46 inclusion_level: false title: MkCode --- ### Sub classes | Name | Children | Inherits | |--- | --- | --- | | **[MkDiagram](https://phil65.github.io/mknodes/)**
*mknodes.basenodes.mkdiagram*
Class representing a mermaid diagram\. |

• [MkClassDiagram](https://phil65.github.io/mknodes/)
• [MkPipDepTree](https://phil65.github.io/mknodes/)

|

• [MkCode](https://phil65.github.io/mknodes/)

| | **[MkTreeView](https://phil65.github.io/mknodes/)**
*mknodes.templatenodes.mktreeview*
Node to display tree structures\. |

|

• [MkCode](https://phil65.github.io/mknodes/)

| ### Base classes | Name | Children | Inherits | |--- | --- | --- | | **[MkContainer](https://phil65.github.io/mknodes/)**
*mknodes.basenodes.mkcontainer*
A node containing other MkNodes\. |

• [MkBlock](https://phil65.github.io/mknodes/)
• [MkAdmonition](https://phil65.github.io/mknodes/)
• [MkBlockQuote](https://phil65.github.io/mknodes/)
• [MkCode](https://phil65.github.io/mknodes/)
• [MkTemplate](https://phil65.github.io/mknodes/)
• [MkList](https://phil65.github.io/mknodes/)
• [MkBaseTable](https://phil65.github.io/mknodes/)
• [MkTab](https://phil65.github.io/mknodes/)
• [MkTabContainer](https://phil65.github.io/mknodes/)
• [MkCritic](https://phil65.github.io/mknodes/)
• [MkAnnotation](https://phil65.github.io/mknodes/)
• ...

|

• [MkContainerBase](https://phil65.github.io/mknodes/)

| ### ⋔ Inheritance diagram

graph TD
  3451338635264["mkcode.MkCode"]
  3451322153984["mkcontainer.MkContainer"]
  3451322152960["mkcontainer.MkContainerBase"]
  3451322151936["mknode.MkNode"]
  140234307508480["builtins.object"]
  3451322153984 --> 3451338635264
  3451322152960 --> 3451322153984
  3451322151936 --> 3451322152960
  140234307508480 --> 3451322151936

### 🛈 DocStrings ::: mknodes.MkCode [:fa-brands-github: Show source on GitHub](https://github.com/phil65/mknodes/blob/main/src/mknodes/basenodes/mkcode/__init__.py)

And this is an alternate tabbed layout:

--- created: source_filename: /home/runner/work/mknodes/mknodes/src/mknodes/pages/mkclasspage/__init__.py source_function: MkClassPage.__init__ source_line_no: 46 inclusion_level: false title: MkCode --- === "DocStrings" ::: mknodes.MkCode === "Sub classes" | Name | Children | Inherits | |--- | --- | --- | | **[MkDiagram](https://phil65.github.io/mknodes/)**
*mknodes.basenodes.mkdiagram*
Class representing a mermaid diagram\. |

• [MkClassDiagram](https://phil65.github.io/mknodes/)
• [MkPipDepTree](https://phil65.github.io/mknodes/)

|

• [MkCode](https://phil65.github.io/mknodes/)

| | **[MkTreeView](https://phil65.github.io/mknodes/)**
*mknodes.templatenodes.mktreeview*
Node to display tree structures\. |

|

• [MkCode](https://phil65.github.io/mknodes/)

| === "Base classes" | Name | Children | Inherits | |--- | --- | --- | | **[MkContainer](https://phil65.github.io/mknodes/)**
*mknodes.basenodes.mkcontainer*
A node containing other MkNodes\. |

• [MkBlock](https://phil65.github.io/mknodes/)
• [MkAdmonition](https://phil65.github.io/mknodes/)
• [MkBlockQuote](https://phil65.github.io/mknodes/)
• [MkCode](https://phil65.github.io/mknodes/)
• [MkTemplate](https://phil65.github.io/mknodes/)
• [MkList](https://phil65.github.io/mknodes/)
• [MkBaseTable](https://phil65.github.io/mknodes/)
• [MkTab](https://phil65.github.io/mknodes/)
• [MkTabContainer](https://phil65.github.io/mknodes/)
• [MkCritic](https://phil65.github.io/mknodes/)
• [MkAnnotation](https://phil65.github.io/mknodes/)
• ...

|

• [MkContainerBase](https://phil65.github.io/mknodes/)

| === "⋔ Inheritance diagram"

graph TD
  3451338635264["mkcode.MkCode"]
  3451322153984["mkcontainer.MkContainer"]
  3451322152960["mkcontainer.MkContainerBase"]
  3451322151936["mknode.MkNode"]
  140234307508480["builtins.object"]
  3451322153984 --> 3451338635264
  3451322152960 --> 3451322153984
  3451322151936 --> 3451322152960
  140234307508480 --> 3451322151936

[:fa-brands-github: Show source on GitHub](https://github.com/phil65/mknodes/blob/main/src/mknodes/basenodes/mkcode/__init__.py)