Skip to content

[core] yarn docs:api ignores some interfaces #4024

@cherniavskii

Description

@cherniavskii

Duplicates

  • I have searched the existing issues

Latest version

  • I have tested the latest version

Current behavior 😯

yarn docs:api (specifically buildInterfacesDocumentation.ts) seems to ignore some of the interfaces like GridApi, GridCellParams and GridColDef.
When one of those interfaces change, docs are not updated.

Ouput
$ yarn docs:api
yarn run v1.22.17
$ yarn docs:api:build
$ cross-env BABEL_ENV=development babel-node -i "/node_modules/(?!@mui)/" -x .ts,.tsx,.js ./docs/scripts/api/buildApi.ts
[BABEL] Note: The code generator has deoptimised the styling of /Users/andrew/workspace/material-ui-x/node_modules/typescript/lib/typescript.js as it exceeds the max of 500KB.
[BABEL] Note: The code generator has deoptimised the styling of /Users/andrew/workspace/material-ui-x/node_modules/lodash/lodash.js as it exceeds the max of 500KB.
Could not resolve "@mui/monorepo/packages/typescript-to-proptypes/src" in file /Users/andrew/workspace/material-ui-x/node_modules/@mui/monorepo/docs/src/modules/utils/parseStyles.ts.
Built API docs for GridRowParams
Built API docs for GridCsvExportOptions
Built API docs for GridPrintExportOptions
Built API docs for GridFilterModel
Built API docs for GridFilterItem
Built API docs for GridFilterOperator
Built JSON file for GridSelectionApi
Built JSON file for GridFilterApi
Built JSON file for GridSortApi
Built JSON file for GridPaginationApi
Built JSON file for GridCsvExportApi
Built JSON file for GridScrollApi
Built JSON file for GridEditingApi
Built JSON file for GridRowGroupingApi
Built JSON file for GridColumnPinningApi
Built JSON file for GridDetailPanelApi
Built JSON file for GridPrintExportApi
Built JSON file for GridDisableVirtualizationApi
Built API docs for GridRowParams
Built API docs for GridCsvExportOptions
Built API docs for GridPrintExportOptions
Built API docs for GridFilterModel
Built API docs for GridFilterItem
Built API docs for GridFilterOperator
Built JSON file for GridSelectionApi
Built JSON file for GridFilterApi
Built JSON file for GridSortApi
Built JSON file for GridPaginationApi
Built JSON file for GridCsvExportApi
Built JSON file for GridScrollApi
Built JSON file for GridEditingApi
Built JSON file for GridRowGroupingApi
Built JSON file for GridColumnPinningApi
Built JSON file for GridDetailPanelApi
Built JSON file for GridPrintExportApi
Built JSON file for GridDisableVirtualizationApi
Built API docs for DataGrid
Built API docs for DataGridPro
Built API docs for DataGrid
Built API docs for DataGridPro
Built events file
Built events file
✨  Done in 21.87s.

Expected behavior 🤔

yarn docs:api builds all interfaces declared in buildInterfacesDocumentation.ts

Steps to reproduce 🕹

Steps:

  1. Add any property to GridColDef, for example:
/**
 * Test
 */
test?: boolean;
  1. Build api docs: yarn docs:api
  2. Observe no changes in grid-col-def.md

Context 🔦

I've discovered it in #4020 where I added a property to GridColDef

Tested on latest master branch (af155b)

Your environment 🌎

`npx @mui/envinfo`
  Don't forget to mention which browser you used.
  Output from `npx @mui/envinfo` goes here.

Order ID 💳 (optional)

No response

Metadata

Metadata

Labels

docsImprovements or additions to the documentation.internalBehind-the-scenes enhancement. Formerly called “core”.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions