我想为用Python编写的restapi生成有用的文档。在
我想应该是这样的:
'''
/kittens/
This method creates kittens in the browser
HTTP Params:
format(default=json): The format in which kittens will be generated.
count(default=10): The number of kittens to generate.
Returns:
A list of kittens.
'''
我的语法显然是:
^{pr2}$我希望解析这种格式并获得(例如)Python dict,最好不使用regex。在
是否已经有针对这种语法的解析器?
如果不是,那么在Python中定义和解析dsl的最简单方法是什么?在
请注意,我更希望而不是使用restructedText或任何与我描述的不同的格式。在
http://sphinx.pocoo.org/
它是一个在线文档工具。你想做什么就做什么。在
我不确定我是否完全理解您想要的内容,但是可以使用RestructedText来捕获示例中的信息:
Sphinx理解此语法,它是Docutils定义的基本reST标记的扩展。在
相关问题 更多 >
编程相关推荐