mddoc:Markdown Python API 文档

时间:2024-07-12 16:49:30
【文件属性】:

文件名称:mddoc:Markdown Python API 文档

文件大小:10KB

文件格式:ZIP

更新时间:2024-07-12 16:49:30

Python

Markdown API 文档器 用于从 Markdown 文档中的 Python 对象生成 API 文档的扩展。 警告! 这是一个带有 alpha 代码的实验项目,可能有很多错误和未经测试的边缘情况。 请随时报告错误(或者甚至更好,提供补丁)并帮助改进它。 句法 要包含来自特定 Python 对象的文档,请在 Markdown 文本中单独包含一个 DocTag。 例如: [% object.name %] DotTag 必须单独位于一行的开头。 这意味着它不能嵌套在列表或块引用中。 理想情况下,它会在它之前和之后被一个空行包围。 请注意,使用的对象名称必须是使用 Python 点表示法的对象的完整导入路径。 对象可以是模块、类、函数或其他此类对象。 当文档呈现为 HTML 时,DocTag 将替换为从该对象的源代码中提取的文档。 期望使用的任何注释都格式化为 Markdown


【文件预览】:
mddoc-master
----MANIFEST.in(100B)
----mddoc()
--------__init__.py(358B)
--------ext.py(1KB)
--------doc.py(13KB)
----setup.py(378B)
----LICENSE.md(1KB)
----.gitignore(369B)
----README.md(8KB)

网友评论