apidocjs没有回复任何内容

时间:2015-07-26 07:18:04

标签: documentation documentation-generation code-documentation api-doc

我在以下命令的帮助下为我的API文档安装'npm'和'node'后安装了'apidoc':

npm install apidoc -g

在全局安装apidoc后,我只是在我的项目目录下运行以下命令(假设apidoc将考虑其默认模板文件):

apidoc

结果没有错误,也没有生成文档。

同样,我尝试过:

apidoc -i ~/PROJECTS/jruby/project/webservice/ -o ~/PROJECTS/apidocs/apidoc/ -t ~/PROJECTS/apidocs/mytemplate/

但没有任何反应,在这种情况下,我在'mytemplate'目录中没有任何内容。

你能告诉我我错过安装/考虑的事吗?为什么命令执行没有出现?

注意:我在我的ruby应用程序中使用它,但由于我们在ruby 1.9上运行我们的应用程序而无法安装它的gem,它需要ruby 2.0。我需要一个独立的解决方案,也适用于其他项目。

谢谢。

1 个答案:

答案 0 :(得分:1)

我得到了解决方案;从https://github.com/apidoc/apidoc复制'package.json'文件并在命令下运行npm

curl -sL https://deb.nodesource.com/setup | sudo bash -

sudo apt-get install nodejs

获得成功后,通过以下步骤正确安装nodejs:

apidoc

然后转到项目目录并运行以下命令:

{{1}}

上述命令成功后,在项目内的doc /目录中获取了html文件。干杯!