Skip to content

[api-documenter] Add new showInheritedMembers config for api-documenter and new api-documenter-scenarios test project #3543

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.

Sign up for GitHub

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

Merged
octogonz merged 11 commits into from
Jul 21, 2022
Merged

[api-documenter] Add new showInheritedMembers config for api-documenter and new api-documenter-scenarios test project #3543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f5afd2f
Rebased and re-ran rush rebuild
zelliott Jun 13, 2022
2d23877
Re-ran rush rebuild
zelliott Jul 20, 2022
be00db9
Some minor clean up and testing improvements to api-documenter
zelliott Jul 20, 2022
3321142
Fix typo
zelliott Jul 20, 2022
f1598af
Improve how diagnostic messages are printed
zelliott Jul 21, 2022
9b69d4f
Again improve diagnostic message
zelliott Jul 21, 2022
b95fcfa
Merge remote-tracking branch 'remotes/origin/main' into inheritance-d…
octogonz Jul 21, 2022
3391667
Run "repo-toolbox readme"
octogonz Jul 21, 2022
a371127
Update install-test-workspace/workspace/common/pnpm-lock.yaml
octogonz Jul 21, 2022
42318bc
Workaround for a Docusaurus MDX incompatibility with our generic Mark…
octogonz Jul 21, 2022
baa19e9
rush change
octogonz Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
| [/build-tests-samples/heft-web-rig-library-tutorial](./build-tests-samples/heft-web-rig-library-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
| [/build-tests-samples/heft-webpack-basic-tutorial](./build-tests-samples/heft-webpack-basic-tutorial/) | (Copy of sample project) Building this project is a regression test for Heft |
| [/build-tests-samples/packlets-tutorial](./build-tests-samples/packlets-tutorial/) | (Copy of sample project) Building this project is a regression test for @rushstack/eslint-plugin-packlets |
| [/build-tests/api-documenter-scenarios](./build-tests/api-documenter-scenarios/) | Building this project is a regression test for api-documenter |
| [/build-tests/api-documenter-test](./build-tests/api-documenter-test/) | Building this project is a regression test for api-documenter |
| [/build-tests/api-extractor-lib1-test](./build-tests/api-extractor-lib1-test/) | Building this project is a regression test for api-extractor |
| [/build-tests/api-extractor-lib2-test](./build-tests/api-extractor-lib2-test/) | Building this project is a regression test for api-extractor |
Expand Down
4 changes: 2 additions & 2 deletions apps/api-documenter/src/documenters/DocumenterConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ export class DocumenterConfig {
public readonly newlineKind: NewlineKind;

/**
* The JSON Schema for API Extractor config file (api-extractor.schema.json).
* The JSON Schema for API Documenter config file (api-documenter.schema.json).
*/
public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(
path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json')
);

/**
* The config file name "api-extractor.json".
* The config file name "api-documenter.json".
*/
public static readonly FILENAME: string = 'api-documenter.json';

Expand Down
5 changes: 5 additions & 0 deletions apps/api-documenter/src/documenters/IConfigFile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,9 @@ export interface IConfigFile {

/** {@inheritDoc IConfigTableOfContents} */
tableOfContents?: IConfigTableOfContents;

/**
* Specifies whether inherited members should also be shown on an API item's page.
*/
showInheritedMembers?: boolean;
}
Loading