Sphinx 和 JavaScript 文档工作流程 [关闭]答案

【问题标题】：Sphinx and JavaScript Documentation Workflow [closed]Sphinx 和 JavaScript 文档工作流程 [关闭]
【发布时间】：2011-12-27 12:42:15
【问题描述】：

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

【问题讨论】：

【解决方案1】：

我相信您正在寻找 Sphinx 的 JavaScript Domain 功能。

编辑：快速浏览一下文档和工具，您似乎无法在 JavaScript 中使用 ReST。您要么必须从 cmets 中找出文档，要么将其保存在 sidecar-files 中。

【讨论】：

没关系，我不想在我的 JavaScript 库中使用 ReST，如果所有库成员都被 sphinx 自动检测到相关的 cmets 会很好。
我不太明白； »自动检测库«成员和 »狮身人面像关联的 cmets«？ AFAIK，Sphinx 根本不知道如何阅读 JavaScript 代码，因此它既不能为您解析函数或其相关文档。这就是我建议使用 sidecar 文件的原因。
这是一个延迟响应，但我一直在寻找其他人是否已经这样做了。当我找不到任何东西时，我只是建造了一些东西。 github.com/Nuulogic/sphinx-jsapidoc 我将其限定为 alpha，它 very、very 特定于您使用的语法——它需要纯 JavaScript。我只在我工作的公司的内部代码上对其进行了测试，但它对我们来说非常可靠。

【解决方案2】：

抱歉回复太晚了）

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

和 oliverseal 一样，我以原生方式为 sphinx 和 ext.autodoc 构建了 sphinx 扩展 sphinxcontrib-autoanysrc

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

您可以使用 sphinxcontrib-autoanysrc 扩展来实现 ext.autodoc 功能，请查看autoanysrc.JSAnalyzer

【讨论】：