适用于Javascript的Sphinx API文档

Question

我正在广泛使用Sphinx进行文档编制，并对此感到满意。

然而，我发现自己做的更多是Javascript（前端）而不是Python。

是否有任何插件或方法可以使用Sphinx的JavaScript代码注释执行类似的API文档，就像Python文档字符串一样？

Answer 1

我遇到了同样的问题，所以我写了sphinx-js来解决它。它基本上是用于JavaScript的autodoc，还有其他一些细节。在Mozilla Hacks博客上有一个more in-depth writeup结束。相似软件包的优点是更好的润色，没有Java依赖，源代码中的标准JSDoc语法，以及autodoc-esque而不是基于包含的工作流。

Answer 2

您可能想查看jsdoc-for-sphinx。我没有尝试过，所以不知道它有多好用。