Skip to content
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

Merged
merged 16 commits into from
Nov 18, 2020

Conversation

AllanZhengYP
Copy link
Contributor

Description of changes:
This change adds 2 typedoc plugins:

  1. client-documentation-generator: It is used when generating each client level api reference
    Screen Shot 2020-11-17 at 11 45 19 PM

  2. Private core-packages-documentation-generator: It generates the landing page for the SDK. It landing page includes links to docs of all the dependency packages in packages, and links to all the docs for each client:
    Screen Shot 2020-11-17 at 11 47 09 PM
    Screen Shot 2020-11-17 at 11 47 27 PM

So the overall API reference is generated in 2 batches:

  1. Build each client's doc by yarn build-documentation --out docs. It will generate docs for each client under docs folder
  2. Build packages docs and link the clients module to the landing page. In the project root: yarn build-documentation --clientDocs clients/{{CLIENT}}/docs

In each step, users can specify the output path with out argument.

TODO:

  1. Regenerate clients with correct Typedoc options

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov-io
Copy link

codecov-io commented Nov 18, 2020

Codecov Report

Merging #1694 (690fea5) into master (de75f7e) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
...tocol_tests/aws-restxml/commands/XmlMapsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ocol_tests/aws-restxml/commands/XmlBlobsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ocol_tests/aws-restxml/commands/XmlEnumsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ocol_tests/aws-restxml/commands/XmlListsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...col_tests/aws-restjson/commands/JsonMapsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ol_tests/aws-restjson/commands/JsonBlobsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ol_tests/aws-restjson/commands/JsonEnumsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...ol_tests/aws-restjson/commands/JsonListsCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...tests/aws-restxml/commands/XmlAttributesCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
...tests/aws-restxml/commands/XmlNamespacesCommand.ts 95.65% <0.00%> (-4.35%) ⬇️
... and 104 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9a62c0a...690fea5. Read the comment docs.

Copy link
Member

@trivikr trivikr left a 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)?

tsconfig.json Outdated Show resolved Hide resolved
packages/node-http-handler/typedoc.js Outdated Show resolved Hide resolved
packages/node-http-handler/tsconfig.json Outdated Show resolved Hide resolved
Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>
@github-actions
Copy link

github-actions bot commented Jan 9, 2021

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants