文件名称：pdocs:一个简单的程序和库，可以自动生成Python模块的API文档
文件大小：431KB
文件格式：ZIP
更新时间：2024-06-12 03:28:40
Python
- pdocs是一个库和一个命令行程序，用于发现Python模块或软件包的公共接口。 pdocs脚本可用于生成模块公共接口的Markdown或HTML，或者可用于运行HTTP服务器，该HTTP服务器为已安装的模块提供生成HTML。 pdocs是由Andrew Gallant（@BurntSushi）实施的麻省理工学院（MIT）许可的原始实现。 目的是忠实于项目创建者提出的最初愿景。 注：对于大多数项目，用最好的方式pdocs是采用。 特征 支持通过遍历抽象语法来查找模块，类和实例变量的文档字符串来记录数据表示形式。 对于其中文档字符串是不恰当（如例 ），特殊变量__pdocs__可以在模块中被用于记录在公开接口的任何标识符。 用法很简单。 只需将您的文档写成Markdown。 没有添加特殊语法规则。 pdocs尊重您的__all__变量（如果存在）。 pdocs会自动将您的文档
【文件预览】：
pdocs-master
----art()
--------logo_large.xcf(814KB)
--------logo_large.png(84KB)
--------logo.png(6KB)
----scripts()
--------clean.sh(117B)
--------test.sh(159B)
--------lint.sh(396B)
----pdocs()
--------logo.py(621B)
--------defaults.py(663B)
--------static.py(3KB)
--------_version.py(22B)
--------__init__.py(7KB)
--------render.py(3KB)
--------cli.py(152B)
--------templates()
--------doc.py(29KB)
--------html_helpers.py(5KB)
--------extract.py(6KB)
--------api.py(5KB)
----.travis.yml(347B)
----tox.ini(480B)
----LICENSE(3KB)
----README.md(6KB)
----docs()
--------quick_start()
--------contributing()
----.codecov.yml(13B)
----tests()
--------test_static.py(2KB)
--------test_pdoc.py(50B)
--------modules()
--------onpath()
--------test_doc.py(775B)
--------docstring_parser()
--------test_extract.py(3KB)
--------test_render.py(475B)
--------test_parse_docstring.py(7KB)
--------tutils.py(245B)
----.gitignore(799B)
----pyproject.toml(1014B)
----CHANGELOG.md(728B)
----.coveragerc(78B)