-
Notifications
You must be signed in to change notification settings - Fork 578
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
feat(api-reference): add typedoc plugins for api reference #1694
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1694 +/- ##
==========================================
- Coverage 79.77% 79.70% -0.08%
==========================================
Files 325 328 +3
Lines 12087 12571 +484
Branches 2553 2670 +117
==========================================
+ Hits 9643 10020 +377
- Misses 2444 2551 +107
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: update title to feat(docs)?
packages/client-documentation-generator/src/sdk-client-toc-plugin.ts
Outdated
Show resolved
Hide resolved
packages/client-documentation-generator/src/sdk-client-toc-plugin.ts
Outdated
Show resolved
Hide resolved
packages/client-documentation-generator/src/sdk-client-toc-plugin.ts
Outdated
Show resolved
Hide resolved
packages/client-documentation-generator/src/sdk-client-toc-plugin.ts
Outdated
Show resolved
Hide resolved
packages/client-documentation-generator/src/sdk-client-comment-update.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
690fea5
to
9a1c9f5
Compare
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread. |
Description of changes:
This change adds 2 typedoc plugins:
client-documentation-generator
: It is used when generating each client level api referencePrivate
core-packages-documentation-generator
: It generates the landing page for the SDK. It landing page includes links to docs of all the dependency packages inpackages
, and links to all the docs for each client:So the overall API reference is generated in 2 batches:
yarn build-documentation --out docs
. It will generate docs for each client underdocs
folderyarn build-documentation --clientDocs clients/{{CLIENT}}/docs
In each step, users can specify the output path with
out
argument.TODO:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.