-
Notifications
You must be signed in to change notification settings - Fork 588
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
[api-documenter] Add new showInheritedMembers
config for api-documenter and new api-documenter-scenarios test project
#3543
[api-documenter] Add new showInheritedMembers
config for api-documenter and new api-documenter-scenarios test project
#3543
Conversation
From Zulip:
I added some logic to api-documenter that logs out the messages and manually inspected that they made sense. They all made sense except surprisingly the |
3e0d3e7
to
3580cf1
Compare
showInheritedMembers
config for api-documenter and new api-documenter-scenarios test project
3580cf1
to
be00db9
Compare
Before merging, we'll test this by regenerating the Rush Stack API reference. |
Here's the branch that I tested with: microsoft/rushstack-websites@767d2a7...octogonz/api-docs-test The output is deployed to the live site: https://api.rushstack.io/pages/ Example of a class with inherited members: https://api.rushstack.io/pages/ts-command-line.commandlineparser/ |
Summary
Fixes #3429. #3469 includes the api-extractor-model changes necessary to support showing an item's inherited members. This PR includes the work in api-documenter to actually show an item's inherited members.
(See zelliott#3 for old PR on fork).
Details
showInheritedMembers
api-documenter config (only supported by theMarkdownDocumenter
at the moment).How it was tested
Ran rush rebuild and manually inspected generated Markdown artifacts.