支持在jsdoc文档化js代码上使用sphinx
sphinx-js的Python项目详细描述
为什么
在编写javascript库时,如何向人们解释它?如果它是用户熟悉的域中的一个小项目,jsdoc按字母顺序列出的例程就足够了。但是,在一个更大的项目中,在api文档中穿插散文非常有用,无需复制和粘贴内容。
sphinx js允许您在js项目中使用业界领先的sphinx文档工具。它提供了一些指令,模式是以python为中心的autodoc,用于将jsdoc格式的文档拉入structuredtext页面。而且,由于可以在代码中继续使用jsdoc,因此可以与其他js工具(如google的闭包编译器)保持兼容。