Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

seratch
Copy link
Member

@seratch seratch commented Jul 10, 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 #1043 but it should be useful for future maintenance.

@seratch seratch requested a review from rm-openai July 10, 2025 03:30
@seratch seratch added the documentation Improvements or additions to documentation label Jul 10, 2025
Copy link
Collaborator

@rm-openai rm-openai left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants