文件名称：python-inspector:自动记录 Python 代码。 想想 Sphinx Autodoc 没有杂乱无章
文件大小：11KB
文件格式：ZIP
更新时间：2024-07-09 16:07:39
Python
检查。 在记录用 Python 编写的库或软件产品时，通常 README 是不够的，但完整的 Sphinx 工作量太大或太死板。 Inspect 是一个命令行工具，可以自动记录 Python 代码，但它以机器可读的 JSON 或人类可读的 Markdown 形式返回输出，因此您可以完全控制如何呈现文档。 用法：检查 [] [选项] 选项：-m --markdown 在什么级别开始标题。 --include ... --exclude ... 如果您只需要记录一个对象（无论是函数、类还是其他东西），您可以使用参数： # will only include documentation on `A` inspect fixtures/example.py A 使用--include和--exclude过滤输出可确保您的代码描述仅包含您想要的内容。 一些例子： # only inc
【文件预览】：
python-inspector-master
----README.rst(2KB)
----inspector()
--------utils.py(1KB)
--------__init__.py(4KB)
--------annotators.py(600B)
--------describe.py(5KB)
--------markdown.html.j2(418B)
--------filters.py(737B)
----fixtures()
--------dependent.py(154B)
--------example.py(1KB)
----examples()
--------template.jade(839B)
----LICENSE(752B)
----setup.py(1KB)
----README.md(2KB)
----Makefile(166B)
----.gitignore(946B)