search

IgniteUI / igniteui-angular

Ignite UI for Angular is a complete library of Angular-native, Material-based Angular UI components with the fastest grids and charts, Pivot Grid, Dock Manager, Hierarchical Grid, and more.
https://www.infragistics.com/products/ignite-ui-angular
Other
568 stars 159 forks source link

Spec files are not excluded upon typedoc generation #10417

Closed zdrawku closed 2 years ago

zdrawku commented 2 years ago

Description

Looking at the typedocOptions, we should exclude the .spec.ts files on api docs generation. Currently that is not the case and a lot of errors are returned:

Working branch: rkaraivanov/ivy-partial-compile-dist

Steps to reproduce

  1. Check out into the branch rkaraivanov/ivy-partial-compile-dist
  2. npm i
  3. npm run build:typedoc:en:staging

Result

image

This is the reason not to have staging environment with the API docs with the latest Angular 13 alfa version

Aleksandyr commented 2 years ago

The problem does not come from TypeDoc. It seems that the branch has some build errors which typedoc identifies when building the project internally and ends the export process for the documentation.

You can check the overlay.spec.ts file where the errors are and fix them.

hanastasov commented 2 years ago

Exclude rule mans that those files will not be used to generate DOCS output. Budiling the docs still need to run the project build.