Auto-update API inventory in autoformat workflow#19157
Merged
Conversation
- Add detection for changes in mlflow/**/*.py or docs/api_reference/**/*.rst - Run `uv run --group docs --extra gateway --directory docs/api_reference make rsthtml` when API-related files change - This will automatically update docs/api_reference/api_inventory.txt during autoformat Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
The dummy target still runs Sphinx build and triggers env-updated event to generate api_inventory.txt, but skips HTML generation for faster execution. Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update api_inventory.txt based on changes in documentation
Auto-update API inventory in autoformat workflow
Dec 2, 2025
harupy
approved these changes
Dec 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes are proposed in this pull request?
Automatically regenerates
docs/api_reference/api_inventory.txtduring autoformat when Python APIs or RST docs change.Changes:
mlflow/**/*.pyordocs/api_reference/**/*.rstuv run --group docs --extra gateway --directory docs/api_reference make dummyto regenerate inventorydummybuilder for speed (parses docs, triggers inventory generation, skips HTML output)How is this PR tested?
Verified:
make dummysuccessfully generatesapi_inventory.txt(~90s execution)Does this PR require documentation update?
Release Notes
Is this a user-facing change?
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/build: Build and test infrastructure for MLflowHow should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionShould this PR be included in the next patch release?
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.