Sphinx和JavaScript文档工作流

对于我的JavaScript框架，我希望使用Sphinx。由于我是斯芬克斯世界的新手，我希望你们能帮助我开始使用斯芬克斯和JavaScript。

我相信你们正在寻找斯芬克斯的功能

---

编辑：从文档和工具中快速收集到的信息来看，您似乎无法在JavaScript中使用ReST。您必须从评论中找出文档，或者将其保存在sidecar文件中。

很抱歉回复太晚）

和你一样，我希望基于AngularJS为我自己的JS框架构建文档

和oliverseal一样，我也是用sphinx和ext.autodoc的原生方式构建sphinx扩展的

它简单而干净，但是有ext.autodoc功能用于自动生成签名和其他功能，但对我来说，它足以将框架API的reST文档存储在js文件中）

---

您可以使用sphinxcontrib autoanysrc扩展签出来实现ext.autodoc功能。这很好，我不想在我的JavaScript库中使用ReST，如果sphinx能够自动检测到所有库成员以及相关的注释，那就太好了；»自动检测库«成员和»sphinx的相关注释«？好吧，Sphinx根本不知道如何读取JavaScript代码，所以它既不能为您解析函数，也不能为您解析相关文档。这就是为什么我建议使用sidecar文件。这是一个延迟响应，但我一直在寻找是否有其他人做了这件事。当我什么都找不到的时候，我就做了些东西。我将它限定为alpha，它非常非常具体地描述了您使用的语法——它需要纯javascript。我只在我工作的公司的内部代码上测试过它，但它对我们来说运行得相当稳定。