feat: add manifest-to-markdown renderer #166
Merged
+5,545
−21
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
paullatzelsperger
force-pushed
the
feat/add_manifest_to_markdown_renderer
branch
from
3f40cd1 to
6464947
Compare
paullatzelsperger
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
...autodoc-plugin/src/main/java/org/eclipse/edc/plugins/autodoc/tasks/MarkdownRendererTask.java
Fixed
Show fixed
Hide fixed
...autodoc-plugin/src/main/java/org/eclipse/edc/plugins/autodoc/tasks/MarkdownRendererTask.java
Fixed
Show fixed
Hide fixed
...c/autodoc-converters/src/main/java/org/eclipse/edc/plugins/autodoc/spi/ManifestRenderer.java
Fixed
Show fixed
Hide fixed
paullatzelsperger
added
documentation
paullatzelsperger
force-pushed
the
feat/add_manifest_to_markdown_renderer
branch
3 times, most recently
from
c249075 to
aab982e
Compare
paullatzelsperger
force-pushed
the
feat/add_manifest_to_markdown_renderer
branch
from
aab982e to
87ff628
Compare
| * @param overview A string containing more information about the extension. Can be null, empty or even multiline. | ||
| * @param type The type of extension module, it can either be an SPI module or an implementation module | ||
| */ | ||
| void renderExtensionHeader(@NotNull String className, @Nullable String name, @Nullable String overview, ModuleType type); |
Check notice
Code scanning / CodeQL
Useless parameter
wolf4ood
approved these changes
Jul 31, 2023
...ers/src/test/java/org/eclipse/edc/plugins/autodoc/markdown/MarkdownManifestRendererTest.java
Outdated
Show resolved
Hide resolved
paullatzelsperger
force-pushed
the
feat/add_manifest_to_markdown_renderer
branch
from
7ad1f95 to
30b0eb3
Compare
jimmarino
approved these changes
Aug 1, 2023
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.
What this PR changes/adds
Adds a task
doc2md, that takes the output JSON ofautodocand converts it into a Markdown file in the same directory (i.e. thebuild/directory).If there is a
manifest.jsonin the rootbuild/dir, then that gets converted as well.Why it does that
Easy and automatic generation of documentation.
Further notes
edc.jsonfiles is async, so./gradlew mergeManifestand./gradlew doc2mdmust be separate gradle invocationsdoc2md->mergeManifestwhatsoeverLinked Issue(s)
Closes # <-- insert Issue number if one exists