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和以下配置生成的:

^{pr2}$

配置

有一些配置参数。在

  • 类\ 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_foldermkdocs.yml。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何将字符串转换为自定义对象   java如何从socket方法获取数据?   Java中的soap读取回车和新行   java在单击时替换图像   java推荐的使用RXJava执行异步任务的方法   java MySql连接器JDBC驱动程序不支持连接池吗?   java将活动堆栈清理到顶部   java计数用户输入的数量   java从webservice下载大文件导致应用程序性能问题   JavaLocalDate。EPOCH不可用   java如何在使用Selenium等待一定时间后,在页面无法加载(get(url))时自动刷新页面   java Calendar setLenient方法不允许检查年份字段的健全性   java Eclipse和intelliJ 安卓 SDK问题   java为什么我可以在没有super关键字的情况下调用父方法?   java iText的PDF格式不好