用于从文档字符串生成降价的文档实用程序
项目描述
code2doc
一个简单的文档实用程序，它从文件、函数和类中获取文档字符串并创建降价文件。
入门
要求：python 3.6+
安装
code2doc 在PyPi上可用，可以使用 pip 轻松安装。
pip install code2doc
如果您已经拥有 code2doc 并想更新到较新的版本
pip install -U code2doc
您可以直接从 dev 分支获取最先进的版本（这可能是不稳定的）
pip install git+https://github.com/rahulsrma26/code2doc
跑步
src/your_module假设您在当前工作目录的目录中拥有所有源代码，那么您可以使用目录构建文档
code2doc build -m ./src/your_module
可以使用命令行或code2doc.ini文件自定义构建选项。code2doc.ini要在当前工作目录中创建文件，请使用
code2doc init
如需其他帮助，请参阅code2doc.ini文件和使用帮助命令和子命令。
code2doc -h
源文档
在此处查看源代码文档。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
code2doc-0.0.4.tar.gz
（12.3 kB
查看哈希）
内置分布
code2doc-0.0.4-py3-none-any.whl
（15.7 kB
查看哈希）