Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TypeDoc CLI Doesn't Generate Default Theme Document #1315

Closed
chrisalexander55 opened this issue May 28, 2020 · 1 comment
Closed

TypeDoc CLI Doesn't Generate Default Theme Document #1315

chrisalexander55 opened this issue May 28, 2020 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@chrisalexander55
Copy link

#841 Search terms
CLI, arguments, args

Expected Behavior

Should generate a default themed document.

Actual Behavior

It produces nothing on the filesystem. Just outputs the following to console:

TypeDoc 0.17.7 Using TypeScript 2.9.2 from /ds-web-components/node_modules/typescript/lib

Steps to reproduce the bug

typedoc.json
{ "name": "Prudential Web Components API Documentation", "includeVersion": true, "tsconfig": "./tsconfig.json", "mode": "file", "theme": "default", "inputFiles": ["./src", "./src/**"], "exclude": "**/*+(.d.ts|.spec|.e2e).ts", "includeDeclarations": false, "ignoreCompilerErrors": true, "out": "./dist/docs", "readme": "./README.md", "version": true }

tsconfig.json
{ "compilerOptions": { "rootDir": "src", "target": "es5", "lib": ["es6", "dom"], "typeRoots": ["node_modules/@types"], "rootDirs": ["src"], "moduleResolution": "node", "emitDecoratorMetadata": true, "experimentalDecorators": true, "strict": false, "sourceMap": true, "baseUrl": ".", "declaration": true, "noImplicitAny": true }, "include": ["src/**/*.ts"], "exclude": ["**/*.spec.ts"] }

CLI cmd:
$ npx typedoc --options typedoc.json

Environment

  • Typedoc version: 0.17.7
  • TypeScript version: 2.9.2
  • Node.js version: 10.15.3
  • OS: OSX 10.14.6
@chrisalexander55 chrisalexander55 added the bug Functionality does not match expectation label May 28, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 28, 2020

This is unactionable. You are running TypeDoc with an unsupported version of TS. I suggest either upgrading TS in your project, or using an older version of TypeDoc.

typedoc/package.json

Lines 34 to 36 in 9118a5c

"peerDependencies": {
"typescript": ">=3.8.3"
},

@Gerrit0 Gerrit0 closed this as completed Jun 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

3 participants
@chrisalexander55 @Gerrit0 and others