Add automation script to generate mkdocstrings files #1048
Merged
Conversation
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
Member Author
| @rm-openai indeed, creating a single file takes only a few seconds, but checking which files are missing (like this PR does) could take much longer and automation script can do better job. |
vrtnis added a commit to vrtnis/openai-agents-python that referenced this pull request Jul 14, 2025
rm-openai approved these changes Jul 21, 2025
vcshih pushed a commit to veris-ai/openai-agents-python that referenced this pull request Aug 15, 2025
This pull request adds a new script for docs, which generates missing `ref/**/*.md` files. The script can be executed when you run `make build-docs` command. The script does not do: - overwrite the existing ones - create files for _XXX.py and `__init__.py` Note that the title part is generated like `tool_context` to `Tool Context`. `openai_provider` will be `Openai Provider`, so some of them needs a little manual work to adjust. The direct need is to add `tool_context.md` for openai#1043 but it should be useful for future maintenance.
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.
This pull request adds a new script for docs, which generates missing
ref/**/*.mdfiles. The script can be executed when you runmake build-docscommand. The script does not do:__init__.pyNote that the title part is generated like
tool_contexttoTool Context.openai_providerwill beOpenai Provider, so some of them needs a little manual work to adjust.The direct need is to add
tool_context.mdfor #1043 but it should be useful for future maintenance.