Skip to content

Typedoc doesn't work with include globs #326

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

Closed
lisss opened this issue Nov 4, 2016 · 0 comments · Fixed by #359
Closed

Typedoc doesn't work with include globs #326

lisss opened this issue Nov 4, 2016 · 0 comments · Fixed by #359

Comments

@lisss
Copy link

lisss commented Nov 4, 2016

We use TS 2.0 globs to include source files. But it seems typedoc doesn't care of the include option in tsconfig - so that the generated doc is empty.
Below is an example of our tsconfig.json:

  "files": [
    "typings/index.d.ts"
  ],
  "include": [
    "lib/**/*.ts*",
    "test/unit/**/*.ts*",
    "scripts/**/*.ts"
  ],
  "rootDirs": [
    "./lib/client",
    "."
  ]

It also ignores the source directory I pass to the command (I could pass non-existing directory - and get no error). My command is:
typedoc --out tsdocs ./lib --ignoreCompilerErrors --theme minimal

Is this a bug or not supported feature? Or am I doing something wrong?

Typedoc version: 0.5.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant