0

在为我的 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​​ 应用程序，但无法安装它的 gem，因为我们在 ruby​​ 1.9 上运行我们的应用程序并且它需要 ruby​​ 2.0。我需要一个独立的解决方案，它也应该适用于其他项目。

谢谢你。

4

1 回答 1

1

我得到了解决方案；从https://github.com/apidoc/apidoc复制“package.json”文件并运行下面的 npm 命令

npm install

成功后通过以下步骤正确安装nodejs：

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

sudo apt-get install nodejs

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

apidoc

上述命令成功后，在项目内的 doc/ 目录中获得了 html 文档。干杯！

于 2015-07-26T15:51:04.740 回答