docs: add typedoc to generate apidoc

apache / pulsar-client-node

Apache Pulsar NodeJS Client

https://pulsar.apache.org/

Apache License 2.0

148 stars 86 forks source link

docs: add typedoc to generate apidoc #314

Closed tisonkun closed 1 year ago

tisonkun commented 1 year ago

This closes https://github.com/apache/pulsar/issues/19876.

Perhaps I'll pick this change to branch-1.8 and generate the first API docs for hosting on our website.

Documentation

[ ] doc-required (Your PR needs to update docs and you will update later)
[ ] doc-not-needed (Please explain why)
[x] doc (Your PR contains doc changes)
[ ] doc-complete (Docs have been already added)

tisonkun commented 1 year ago

@BewareMyPower Make sense. I'll add one entry. Also I'll integrate this function to apache/pulsar-siite/tools/pytools and update the release guide (we should generate for feature releases).

shibd commented 1 year ago

Perhaps I'll pick this change to branch-1.8 and generate the first API docs for hosting on our website.

Yes, I'll plan to release v1.8.2 next week. After this is merged, I'll cherry-pick this.

tisonkun commented 1 year ago

Merging...

Thanks for your review.

momo-jun commented 1 year ago

@tisonkun, what's the public URL to view the new API docs for Node.js clients? We may need to add this link to the client doc.

tisonkun commented 1 year ago

@momo-jun Perhaps we can reopen the issue for now. There are still several follow-ups to landing the page online: