【问题标题】:apidocjs not returning anything in responseapidocjs 没有返回任何响应
【发布时间】:2015-07-26 07:18:03
【问题描述】:

在为我的 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。我需要一个适用于其他项目的独立解决方案。

谢谢。

【问题讨论】:

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


    【解决方案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 文档。干杯!

    【讨论】:

      猜你喜欢
      • 2021-04-17
      • 2021-06-27
      • 2018-11-15
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2020-08-16
      • 1970-01-01
      相关资源
      最近更新 更多