pdoc:自动为Python项目生成API文档

时间:2024-02-26 03:28:16
【文件属性】:

文件名称:pdoc:自动为Python项目生成API文档

文件大小:137KB

文件格式:ZIP

更新时间:2024-02-26 03:28:16

python documentation docs generator api-documentation

pdoc 自动生成Python项目的API文档。 安装 $ pip install pdoc3 用法 Pdoc将接受Python模块文件,软件包目录或导入路径。 $ pdoc your_project 有关更多的命令行开关,请参见pdoc --help ;有关更多用法示例,请参见。 产品特点 使用简单。 无需任何特殊配置即可生成明智的API(+散文)文档。 支持常见的(Markdown,numpydoc,Google风格的文档字符串),LaTeX数学和一些。 支持和类型注释。 PDOC方面当存在时。 如果未指定,则类成员的文档字符串。 通过遍历AST支持记录模块,类和实例。 自


【文件预览】:
pdoc-master
----pdoc()
--------documentation.md(14KB)
--------__init__.py(59KB)
--------__main__.py(89B)
--------test()
--------cli.py(19KB)
--------templates()
--------html_helpers.py(24KB)
----MANIFEST.in(79B)
----.github()
--------FUNDING.yml(14B)
--------issue_template.md(231B)
--------lint-markdown.sh(452B)
--------deploy-gh-pages.sh(959B)
--------workflows()
----LICENSE.txt(34KB)
----doc()
--------build.sh(2KB)
--------README.md(141B)
--------pdoc_template()
--------logo.png(29KB)
----CONTRIBUTING.md(2KB)
----setup.cfg(177B)
----setup.py(2KB)
----README.md(3KB)
----.pre-commit-hooks.yaml(217B)
----.codecov.yml(291B)
----.gitignore(108B)
----.coveragerc(194B)
----CHANGELOG(12KB)

网友评论