Azure / Azure/azure-sdk-for-java

Generate api.md for Java module

Open
#50,227 1 comment 1 reaction 1 assignee Claimed by @weidongxu-microsoft View on GitHub
needs-triage
Dominant language
Java
Stars
2.6k
Forks
2.2k
Avg merge
2d 8h
Merged PRs (30d)
178

Description

Add `--renderer=markdown` option to https://github.com/Azure/azure-sdk-tools/tree/main/src/java/apiview-java-processor

- https://github.com/Azure/azure-sdk-tools/pull/16809

---

Integration

- [ ] integrate into SDK Generation pipeline
- [ ] command to generate `api.md` when user does not use the pipeline (this is what Python does -- another alternative is to have agent on PR to regen the `api.md` and commit, if not match)

---

Question

- How to build the apiview-java-processor, given it currently in the tools repo? Should we move it into SDK repo? Or upload the build to devfeed?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.