Sphinx和JavaScript文档工作流程

时间:2011-12-27 12:42:15

标签: javascript python documentation python-sphinx restructuredtext

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

  

任何帮助表示感谢。

最诚挚的问候

2 个答案:

答案 0 :(得分:1)

我相信你正在寻找Sphinx'JavaScript Domain功能。

编辑:快速收集文档&工具,看起来你不能在你的JavaScript中使用ReST。你要么必须从评论中删除文档,要么将其保存在sidecar文件中。

答案 1 :(得分:0)

对不起太迟回复了)

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

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

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

您可以使用sphinxcontrib-autoanysrc扩展程序实现ext.autodoc功能检出autoanysrc.JSAnalyzer