2016-01-26 7 views
6

मैं TypeDoc का उपयोग कर दस्तावेज़ फ़ाइलों को उत्पन्न करने का प्रयास कर रहा हूं। जब मैं follwing कमांड के साथ TypeDoc चलाएँ:टाइपडोक Angular2 मॉड्यूल नहीं देख सकता

/node_modules/.bin/typedoc --module system --target ES5 --exclude *.spec.ts* --experimentalDecorators --out typedoc app/ --ignoreCompilerErrors 

यह आउटपुट के रूप में देता है:

Using TypeScript 1.6.2 from /development/node_modules/typedoc/node_modules/typescript/lib 
Error: /development/app/angular2/app.ts(1) 
Cannot find module 'angular2/core'. 
Error: /development/app/angular2/app.ts(2) 
Cannot find module 'angular2/upgrade'. 
Error: /development/app/angular2/app.ts(3) 
Cannot find module 'angular2/platform/browser'. 
Error: /development/app/angular2/app.ts(5) 

tsconfig.json

{ 
    "compilerOptions": { 
    "target": "ES5", 
    "module": "system", 
    "moduleResolution": "node", 
    "sourceMap": true, 
    "emitDecoratorMetadata": true, 
    "experimentalDecorators": true, 
    "removeComments": false, 
    "noImplicitAny": false 
    }, 
    "exclude": [ 
    "node_modules" 
    ] 
} 

वहाँ मैं यहाँ याद आ रही है पैरामीटर किसी तरह का है libs या .d.ts. फ़ाइलों को शामिल करने के लिए?

+0

संभवतः tsconfig.json से संबंधित कुछ मुद्दे प्रयास करें। क्या आप इसे पोस्ट कर सकते हैं? –

+0

मैंने अपने tsconfig, जेसन को प्रश्न में जोड़ा है –

उत्तर

1

मैं टाइपरोक का उपयोग कोणीय 2 अनुप्रयोग के साथ करता हूं। हालांकि मैं इसे गल्प-टाइपिडोक के माध्यम से चलाता हूं, लेकिन पास पैरामीटर समान होना चाहिए। निम्नलिखित गल्प कार्य मेरे लिए नौकरी करता है:

gulp.task("doc", function() { 
    return gulp 
     .src(["./myproject/**/*.ts"]) 
     .pipe(typedoc({ 
      // TypeScript options (see typescript docs) 
      module: "commonjs", 
      target: "es5", 
      includeDeclarations: false, 
      experimentalDecorators: true, 

      // Output options (see typedoc docs) 
      out: "./docs", 

      // TypeDoc options (see typedoc docs) 
      name: "MyProject", 
      ignoreCompilerErrors: false, 
      excludeExternals:true, 
      version: true, 
     })); 
}); 

आशा है कि इससे मदद मिलती है।

3

मैंने आमज मॉड्यूल के साथ प्रयास किया और यह काम किया।

typedoc --experimentalDecorators --target 'es5' --module 'commonjs' --out doc-destination/ src/ 
0

अपने tsconfig.json में प्रकार परिभाषा फ़ाइलों के लिए विन्यास जोड़ें और

"typeRoots": [ 
    "node_modules/@types" ] 
संबंधित मुद्दे