Question

我试图设置TypeDoc来从TypeScript项目构建文档。

typedoc                              \
    --out ./docs                     \
    --theme minimal                  \
    --name MyProject                 \
    --readme ./README.md             \
    --mode modules                   \
    --target ES6                     \
    --includeDeclarations            \
    --externalPattern "node_modules" \
    --excludeExternals               \
    --hideGenerator                  \
    ./src/

Typedoc只会发出USAGE并退出。没有其他错误消息。我也尝试过：

typedoc --mode modules --out ./docs/ ./src/

也不起作用。我也尝试过编写一个typedoc.js文件：

module.exports = {
    out: './docs',
    name: 'MyProject',
    readme: './README.md',
    externalPattern: 'node\\_modules',
    hideGenerator: true,
    target: 'ES6',
    jsx: 'preserve',
    experimentalDecorators: true
};

并在控制台上指定：

typedoc --mode modules --options typedoc.js src/

无济于事;我所看到的只是USAGE字符串。

我花了两个小时尝试调试typedoc以查看发生了什么，我怀疑TypeDoc根本没有看到任何源文件。我还尝试指定src/main.ts而不仅仅是目录src，但这也没有帮助。

我不知所措，我无法让这件事发挥作用。有什么想法吗？

$ typedoc --version
TypeDoc 0.4.4
Using TypeScript 1.8.10 from /usr/lib/node_modules/typedoc/node_modules/typescript/lib

TypeDoc不起作用

0 个答案: