python文档的降价扩展
jetblack-markdown的Python项目详细描述
喷气式降价
自动文档生成的降价扩展 (阅读docs)。在
降价扩展
提供了一个markdown扩展来自动记录python代码。在
模块如下所示:
# A Top Level Module @[jetblack_markdown] # A Package @[jetblack_markdown.autodoc] # A function @[jetblack_markdown.autodoc:makeExtension] # A class @[jetblack_markdown.autodoc.metadata:PropertyDescriptor]
mkdocs集成
此站点是使用mkdocs
和以下配置生成的:
配置
有一些配置参数。在
- 类\ from_init(bool,可选):如果为True,则使用 类的函数。默认为 是的。在
- ignore_dunder(bool,可选):如果为True,则忽略 __XXX功能。默认为True。在
- ignore_private(bool,可选):如果为True,则忽略方法 (前缀为\u XXX)。默认为True。在
- ignore\u all(bool):如果为True,则忽略\uu all\uuu成员。在
- 首选DOCU字符串(如果首选DOCU字符串)。在
- template_folder(可选[str],可选):指定自定义模板文件夹。
模板“主。金贾2“将通过一个
obj
参数呈现 它是一个jetblack.markdown.metadata.Descriptor
自定义
所有的渲染都是用jinja2模板完成的。从复制当前
来自jetblack_markdown/templates的模板,并在中指定template_folder
mkdocs.yml
。在
- 项目
标签: