我写了一个epytext http://epydoc.sourceforge.net/epytext.html to reST http://docutils.sourceforge.net/docs/user/rst/quickref.html标记转换器,现在我想将整个库中的所有文档字符串从 epytext 转换为 reST 格式。
有没有一种聪明的方法来读取模块中的所有文档字符串并写回替换内容?
ps: ast http://docs.python.org/dev/library/ast.html也许是模块?
Pyment https://github.com/dadadel/pyment是一个可以转换 Python 文档字符串并创建缺失框架的工具。它可以管理Google, Epydoc(javadoc风格),Numpydoc, 重构文本(reST,Sphinx 默认)文档字符串格式。
它接受单个文件或文件夹(也探索子文件夹)。对于每个文件,它将识别每种文档字符串格式并将其转换为所需的格式。最后,将生成一个补丁以应用于该文件。
要转换您的项目:
键入以下内容(您可以使用 virtualenv):
$ git clone https://github.com/dadadel/pyment.git
$ cd pyment
$ python setup.py install
您可以通过执行以下操作将项目转换为 Sphinx 格式 (reST),这是默认输出格式:
$ pyment /my/folder/project
EDIT:
安装使用pip:
$ pip install git+https://github.com/dadadel/pyment.git
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)