- Notifications
You must be signed in to change notification settings - Fork2k
Add automation script to generate mkdocstrings files#1048
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Hey@seratch the code looks totally fine but I actually don't get why we need this? Why can't the files just be hand-written, takes like 5 seconds lol
seratch commentedJul 14, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@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. |
This pull request adds a new script for docs, which generates missing
ref/**/*.md
files. The script can be executed when you runmake build-docs
command. The script does not do:__init__.py
Note that the title part is generated like
tool_context
toTool Context
.openai_provider
will beOpenai Provider
, so some of them needs a little manual work to adjust.The direct need is to add
tool_context.md
for#1043 but it should be useful for future maintenance.