Skip to content
This repository was archived by the owner on Nov 6, 2019. It is now read-only.

Docs don't build #157

Closed
sccolbert opened this issue Nov 3, 2016 · 4 comments
Closed

Docs don't build #157

sccolbert opened this issue Nov 3, 2016 · 4 comments
Assignees

Comments

@sccolbert
Copy link
Member

I couldn't get TypeDoc ^0.5.0 to build with TS 2, because it doesn't seem that TypeDoc accepts the full suite of tsconfig options (like which built-in libs to use). I also didn't spend a bunch of time on it, since docs have been broken for a while.

cc @blink1073

@jasongrout
Copy link
Member

jasongrout commented Nov 6, 2016

You're right, typedoc 0.5.0 chokes on tsconfig TS2-specific options. For JLab, we don't use the tsconfig - we just let typedoc use default settings to generate docs for all of the .ts files. Apparently typedoc 0.5.1 will ignore TS2 options (see TypeStrong/typedoc#308). I haven't tested that yet, though.

@blink1073
Copy link
Contributor

Note: support is still not there: TypeStrong/typedoc#301

@blink1073
Copy link
Contributor

Progress! TypeStrong/typedoc#449

@jasongrout
Copy link
Member

I wonder if microsoft/TypeScript#13940 (slated for TS 2.3, I believe) will make it easier to have a documentation generator as a source code transformation.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants