تایپاسکریپت - TypeDoc کار نمیکند
من در حال تلاش برای راهاندازی TypeDoc هستم تا مستندات را از یک پروژه TypeScript بسازد.
typedoc \
--out ./docs \
--theme minimal \
--name MyProject \
--readme ./README.md \
--mode modules \
--target ES6 \
--includeDeclarations \
--externalPattern "node_modules" \
--excludeExternals \
--hideGenerator \
./src/
تایپداک به سادگی پیام 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/
بیفایده؛ تنها چیزی که همیشه میبینم رشته استفاده است.
من دو ساعت را صرف تلاش برای دیباگ کردن 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