Skip to content

[code-infra] Make the API docs builder more configurable #43574

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

Jump to bottom
Merged
merged 3 commits into from
Sep 4, 2024
Merged

[code-infra] Make the API docs builder more configurable #43574

merged 3 commits into from
Sep 4, 2024

Conversation

@michaldudak
Copy link
Member

@michaldudak michaldudak commented Sep 2, 2024 •
edited
Loading

Makes API docs builder more configurable:

  • translations directory can be set
  • API manifest file generation can be skipped
  • MDX files are considered when looking for pages

Additionally fixed the translations path not being respected for hooks.

@michaldudak michaldudak requested review from a team September 2, 2024 13:58
@mui-bot
Copy link

mui-bot commented Sep 2, 2024 •
edited
Loading

Netlify deploy preview

https://deploy-preview-43574--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 9605244

@michaldudak michaldudak changed the title Api docs builder for base UI [code-infra] Make The API docs builder more configurable Sep 3, 2024
@michaldudak michaldudak changed the title [code-infra] Make The API docs builder more configurable [code-infra] Make the API docs builder more configurable Sep 3, 2024
@michaldudak michaldudak mentioned this pull request Sep 3, 2024
Merged
23 tasks
Janpot
Janpot approved these changes Sep 3, 2024
View reviewed changes
Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fine

@michaldudak michaldudak merged commit 8094d0b into mui:master Sep 4, 2024
@michaldudak michaldudak deleted the api-docs-builder-for-base-ui branch September 4, 2024 11:52
This was referenced Oct 3, 2024
Open
Open
This was referenced Oct 3, 2024
Closed
Closed
@Msolmaz4 Msolmaz4 mentioned this pull request Oct 3, 2024
Open
@zannager zannager added the scope: code-infra Involves the code-infra product (https://www.notion.so/mui-org/5562c14178aa42af97bc1fa5114000cd). label Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Janpot Janpot Janpot approved these changes

Assignees

No one assigned

Labels

scope: code-infra Involves the code-infra product (https://www.notion.so/mui-org/5562c14178aa42af97bc1fa5114000cd).

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@michaldudak @mui-bot @Janpot @zannager