search

tildeio / libkit

17 stars 4 forks source link

Add Docs script that uses typedoc #8

Closed knownasilya closed 5 years ago

knownasilya commented 6 years ago

Allows it to be setup with github docs really easily.

screen shot 2018-02-08 at 12 49 31 pm

chancancode commented 6 years ago

@knownasilya are you using this setup in your project? last time we tried, we find that it doesn't really work because (at the time, at least) typedoc does not support following re-exports

knownasilya commented 6 years ago

Yeah, using it here https://knownasilya.github.io/google-maps-drawing-tools/

wycats commented 5 years ago

At the time this PR was originally submitted, we looked into TypeDoc and considered its lack of re-export support to be a fatal flaw for the projects we use libkit for. We tried to fix the issue in TypeDoc, but its heavy use of internal TypeScript types made us uneasy.

This problem still seems to be an open issue, but it points to Microsoft's API Extractor, which I am looking into.

💃

mike-north commented 5 years ago

This problem still seems to be an open issue, but it points to Microsoft's API Extractor, which I am looking into.

API extractor is unusable for any project that contains even one .js file, since its input is declaration files. It also does not mix well with the kind of JSDoc syntax that the ts compiler uses for type information (really this is https://github.com/Microsoft/tsdoc that's used as a block comment parser -- it's very opinionated in ways that make it hard to think of as a general use tool)