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.

Sign up for GitHub

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

Jump to bottom

jsii-docgen does not generate markdown for the submodules #1

Closed
yashda opened this issue Jul 7, 2020 · 1 comment · Fixed by #172
Closed

jsii-docgen does not generate markdown for the submodules #1

yashda opened this issue Jul 7, 2020 · 1 comment · Fixed by #172
Assignees
@eladb
Labels
bug This issue is a bug. effort/small Small work item – less than a day of effort in-progress Issue is being actively worked on. p1

Comments

@yashda
Copy link

yashda commented Jul 7, 2020

If a typescript project contains an exported module (submodule for jsii), no information is generated in the markdown when jsii-docgen is ran against it.
@SomayaB SomayaB added the bug This issue is a bug. label Jul 8, 2020
@eladb
Copy link
Contributor

eladb commented Jul 16, 2020

Happy to take a contribution for this.

@eladb eladb added the p1 label Jul 16, 2020
@eladb eladb added the effort/small Small work item – less than a day of effort label Aug 4, 2020
@eladb eladb mentioned this issue Nov 19, 2020
Merged
eladb pushed a commit to projen/projen that referenced this issue Nov 24, 2020
feat: consolidate github capabilities behind a centralized api (#319)
19815c1 
Move all GitHub and VsCode related components under a single API that can be accessed from the project level.

NOTE: API.md does not have support for submodules (yet) cdklabs/jsii-docgen#1 but all the GitHub component types are exported under the `github` submodule: `import github from 'projen'`.

Closes #318 

BREAKING CHANGE: there are multiple breaking changes in in how github components are used.
@Chriscbr Chriscbr mentioned this issue Dec 11, 2020
Merged
@SomayaB SomayaB added the in-progress Issue is being actively worked on. label Dec 14, 2020
eladb pushed a commit that referenced this issue Dec 14, 2020
@Chriscbr
feat: generate docs for jsii submodules (#172)
692c07f 
Fixes #1 

- Adds docs for all classes, structs, interfaces, and enums in submodules
- Changes class initialization examples to include submodule paths, e.g. `new foo.MyClass(...)` instead of `new MyClass(...)`
- Updates class docs to include a "submodule" section if the class has an associated namespace
- Modifies tsconfig to allow using flatMap

I tested this with docs for [projen](https://github.com/projen/projen), and the would-be updated docs are here: https://gist.github.com/Chriscbr/41f7f7e7d1d358dc6ebf0f8cb277b937
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eladb eladb

Labels
bug This issue is a bug. effort/small Small work item – less than a day of effort in-progress Issue is being actively worked on. p1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: generate docs for jsii submodules Chriscbr/jsii-docgen
3 participants
@eladb @SomayaB @yashda