Document and resolve imported types. #646
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Converter that converts and resolves imported declarations of any kind and includes them into the docs.
Point the URLs of imported declarations to their original exported declaration.
|
@makana what is the release timeline for this PR? |
|
#1157 has been merged with support for handling imported types. Thank you for the PR! It was a lot of help in determining how best to handle imported types. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Import declarations of any kind are included into the docs. Used imported types are resolved as long as they are part of the source files that are documented.
Commit 01f040c includes all the logic.
Commit ad39cce modifies the theme builder to point the URLs of import declarations to their original exported declaration. I am not sure if it is the intended behavior as I only use the JSON output but I tried a few things with the default theme and it makes more sense to me to do so.
Related to #516 #498 #435 #428 #159 and maybe fixes all of them.