javascript - Javascript 的 Sphinx API 文档

Question

我在文档中广泛使用 Sphinx，并且对它感到满意。

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

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

Answer 1

我有同样的问题，所以我写了sphinx-js来解决它。它基本上是 JavaScript 的 autodoc，还有一些其他的细节。Mozilla Hacks 博客上有更深入的文章。与类似包相比的优势是更好的润色、无 Java 依赖、源代码中的标准 JSDoc 语法以及 autodoc-esque 而不是基于包含的工作流。

Answer 2

您可能想查看jsdoc-for-sphinx。我还没有尝试过，所以不知道效果如何。