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

When using split-by-submodule, documentation for the root of the project is not generated #1240

Closed
mbonig opened this issue Dec 12, 2023 · 0 comments · Fixed by #1249
Closed

Comments

@mbonig
Copy link

mbonig commented Dec 12, 2023

Currently using jsii-docgen with projen and would like to have docs split up by submodule, using the --split-by-submodule option. However, when using this, no documentation is produced for the constructs in the root of the project.

The full command:

$  npx jsii-docgen .jsii -o docusaurus/docs/api/api --split-by-submodule

With this, I get an 'api.md' file in the docusaurus/docs/api directory that has the following contents:

# Submodules <a name="Submodules" id="submodules"></a>

The following submodules are available:
- [awscdk](./awscdk.md)
- [build](./build.md)
- [cdk](./cdk.md)
- [cdk8s](./cdk8s.md)
- [cdktf](./cdktf.md)
- [circleci](./circleci.md)
- [github](./github.md)
- [gitlab](./gitlab.md)
- [java](./java.md)
- [javascript](./javascript.md)
- [python](./python.md)
- [release](./release.md)
- [typescript](./typescript.md)
- [vscode](./vscode.md)
- [web](./web.md)

But none of those files contain any of the documentation for files in the 'src' directory, like gitpod.ts, ignore-file.ts, and others.

How can I have smaller, more fine-grained documentation files, without losing documentation for constructs in the root of the project?

@mergify mergify bot closed this as completed in #1249 Dec 19, 2023
mergify bot pushed a commit that referenced this issue Dec 19, 2023
… namespace (#1249)

Extend the "index" page to contain a list of submodules and the reference for any symbols in the root namespace.

Fixes #1240
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 a pull request may close this issue.

1 participant