javascript - Javascript 的 Sphinx API 文档

标签 javascript python-sphinx

我广泛使用 Sphinx 来制作文档并且对它感觉很舒服。

但是,我发现自己更多地使用 Javascript(前端)而不是 Python。

是否有任何插件或方法可以像使用 Python 文档字符串那样使用 Sphinx 从 JavaScript 代码注释中创建类似的 API 文档?

最佳答案

我有同样的问题,所以我写了sphinx-js解决它。它基本上是 JavaScript 的 autodoc,还有一些其他的优点。有一个 more in-depth writeup在 Mozilla Hacks 博客上。与类似包相比的优势是更好的润色、无 Java 依赖性、源代码中的标准 JSDoc 语法以及类似 autodoc 而非基于包含的工作流。

关于javascript - Javascript 的 Sphinx API 文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12446173/

相关文章:

javascript - Bootstrap 不工作,但包含 js 和 css

javascript - 如何使用 jquery 应用这几个 css 设置?

javascript - 如何在 Angular 1.5 组件中等待 UI Router Resolve 的 promise

pycharm - 未知指令类型 "toctree"。 Pycharm 中的错误,但 index.html 有效

python-sphinx - 如何使用 Sphinx 创建 (#) 样式的编号列表

javascript - 具有相对路径的 jsdom 和 script 标签

javascript - google.maps.places 有时未定义

python-sphinx - 是否可以在 sphinx.ext.napoleon 中提供参数列表?

python - 如何打破第一个文档字符串中的链接以满足 pep8?

python - 狮身人面像 : customize sidebar section titles