Section

类数据类源码

Section(title: str, level: int = 0, content: list[str] = [])

从 Markdown 字符串中提取出的文档章节。

字段

字段	类型	必选	说明
title	str		标题文本。
level	int		标题的等级数字。
content	list[str]		章节的正文内容，按行保存。

方法

as_md_text

v_1: str = self.as_md_text()

渲染为 Markdown 文字。

输出

参数	类型	说明
v_1	str	从章节渲染的 Markdown 文本。

---

from_md_text

v_1: list[Self] = Section.from_md_text(md_text: str | None)

将 Markdown docstring 提取成章节列表。

每个章节都以它的标题作为起始标志。

输入

参数	类型	必选	说明
md_text	str | None		待解析的文字。通常是 docstring。

输出

参数	类型	说明
v_1	list[Self]	章节列表。每个章节都以其标题开头。内容按行保存为列表。如果某个章节缺少标题文字，则其标题等级设为0。