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

Add Docs script that uses typedoc #8

Closed
wants to merge 3 commits into from

Conversation

knownasilya
Copy link
Contributor

Allows it to be setup with github docs really easily.

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

@chancancode
Copy link
Member

@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
Copy link
Contributor Author

@wycats
Copy link
Contributor

wycats commented Apr 6, 2019

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.

💃

@wycats wycats closed this Apr 6, 2019
@mike-north
Copy link

mike-north commented Apr 6, 2019

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)

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

Successfully merging this pull request may close these issues.

None yet

4 participants