mkdocs-yaarg-plugin:适用于MKDocs的另一个API参考生成器插件

时间:2024-04-03 16:36:23
【文件属性】:

文件名称:mkdocs-yaarg-plugin:适用于MKDocs的另一个API参考生成器插件

文件大小:15KB

文件格式:ZIP

更新时间:2024-04-03 16:36:23

python documentation mkdocs-plugin Python

mkdocs-yaarg-plugin Y等甲诺特尔甲PIřeferenceģenerator插件 。 安装 从PyPI安装软件包, pip install mkdocs-yaarg-plugin[parso] 然后将其添加到mkdocs.yml : plugins : - yaarg 用法 # API Reference ::: some/filepath/to/module.py 有关其他选项和详细信息,请参见。 为什么 作为Python docstring文档生成器: 快速和静态 yaarg的默认Python生成器不依赖任何运行时数据。 执行Python代码来构建文档完全是不必要的,缓慢的并且有潜在危险。 作为一般的API参考生成器: 语言不可知 对降价输出的外观没有意见 这样一来,他们可以轻松地在其生态系统中利用现有的文档工具。


【文件预览】:
mkdocs-yaarg-plugin-main
----yaarg()
--------mkdocs.py(1KB)
--------generators()
--------markdown.py(2KB)
--------__init__.py(103B)
--------resolver.py(2KB)
----requirements()
--------extra.txt(73B)
--------dev.txt(124B)
--------base.txt(47B)
----.github()
--------workflows()
----.bumpversion.cfg(377B)
----mkdocs.yml(229B)
----setup.py(2KB)
----README.md(902B)
----Makefile(125B)
----docs()
--------index.md(364B)
--------assets()
--------api()
----.gitignore(2KB)
----pyproject.toml(117B)

网友评论