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

feat: generate docs for jsii submodules #172

Merged
merged 5 commits into from
Dec 14, 2020

Conversation

Chriscbr
Copy link
Contributor

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, and the would-be updated docs are here: https://gist.github.com/Chriscbr/41f7f7e7d1d358dc6ebf0f8cb277b937

@Chriscbr Chriscbr changed the title Feat/submodule docs feat: generate docs for jsii submodules Dec 11, 2020
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The names in the TOC tables should also include the submodule prefix.

For example, in projen, the Github class should be named github.Github

.projenrc.js Outdated Show resolved Hide resolved
.projenrc.js Outdated Show resolved Hide resolved
@eladb eladb merged commit 692c07f into cdklabs:master Dec 14, 2020
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.

jsii-docgen does not generate markdown for the submodules
2 participants