-
Notifications
You must be signed in to change notification settings - Fork 161
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
fix(typedoc): adding to excluded paths #11162
Conversation
"projects/igniteui-angular/schematics/" | ||
"projects/igniteui-angular/schematics/", | ||
"projects/igniteui-angular/cypress/", | ||
"cypress/", |
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.
Oh so this is the main tsconfig? Assuming cypress run would have their own tsconfig this is fine, but also kind of weird. As far as I can see typedoc has options below and those are based on this exclude list, yet there are entry point options.
So the config can be improved in the future. We're interested in API for the project lib only
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.
Actually, there's a tsconfig.typedoc.json
already present in the repo. What's lacking is it doesn't seem to be in use for the actual command:
Lines 234 to 240 in f9db7af
function typedocBuildDocsEN (cb) { | |
spawnSync('typedoc', [ | |
TYPEDOC.PROJECT_PATH, | |
'--localize', | |
'en', | |
"--tsconfig", | |
path.join(__dirname,"tsconfig.json")], { stdio: 'inherit', shell: true}); |
Replace the
tsconfig.json
on L240 w/ tsconfig.typedoc.json
and it should work fine
Co-authored-by: Damyan Petev <[email protected]>
Closes #
Additional information (check all that apply):
Checklist:
feature/README.MD
updates for the feature docsREADME.MD
CHANGELOG.MD
updates for newly added functionalityng update
migrations for the breaking changes (migrations guidelines)