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

fix(typedoc): adding to excluded paths #11162

Merged
merged 4 commits into from
Mar 4, 2022
Merged

fix(typedoc): adding to excluded paths #11162

merged 4 commits into from
Mar 4, 2022

Conversation

kdinev
Copy link
Member

@kdinev kdinev commented Mar 4, 2022

Closes #

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

Checklist:

  • All relevant tags have been applied to this PR
  • This PR includes unit tests covering all the new code (test guidelines)
  • This PR includes API docs for newly added methods/properties (api docs guidelines)
  • This PR includes feature/README.MD updates for the feature docs
  • This PR includes general feature table updates in the root README.MD
  • This PR includes CHANGELOG.MD updates for newly added functionality
  • This PR contains breaking changes
  • This PR includes ng update migrations for the breaking changes (migrations guidelines)
  • This PR includes behavioral changes and the feature specification has been updated with them

@ChronosSF ChronosSF changed the base branch from master to 13.1.x March 4, 2022 09:36
@ChronosSF ChronosSF self-assigned this Mar 4, 2022
.github/workflows/nodejs.yml Outdated Show resolved Hide resolved
"projects/igniteui-angular/schematics/"
"projects/igniteui-angular/schematics/",
"projects/igniteui-angular/cypress/",
"cypress/",
Copy link
Member

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

Copy link
Member

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:

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

@ChronosSF ChronosSF requested a review from damyanpetev March 4, 2022 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants