文件名称:markdocs:从Python源文件注释中提取markdown并输出结构化文档和自述文件-python source file
文件大小:8KB
文件格式:ZIP
更新时间:2024-04-14 01:38:05
系统开源
markdocs 从Python源文件注释中提取markdown并输出结构化文档和README文件。 Python文档 我喜欢在Rustlang中使用Markdown编写功能文档,因此我将做一些实验以在Python中具有相同的功能。 看一下 ,一个使用为Rust板条箱生成的文档站点。 使用python -m tokenize file.py 提取信息 怎么运行的 注意:这只是一个早期想法,尚未实现! 如果您喜欢,请发表评论。 Markdocs从所有.py文件中提取文档,并在一个组织良好的文档html站点中输出该文档,该站点可以使用mkdocs.org进行公开和部署。 markdocs /path/to/project 如果您不想生成完整的文档,则可以轻松地为您的仓库生成一个自述文件。 markdocs /path/project --readme README.md -k '
【文件预览】:
markdocs-master
----flit.ini(597B)
----.gitignore(1KB)
----LICENSE(1KB)
----README.md(4KB)
----tests()
--------tokenize.stdout(6KB)
--------example.py(2KB)
----markdocs()
--------__init__.py(355B)