Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
seratch wants to merge2 commits intomain
base:main
Choose a base branch
Loading
fromautomate-mkdocstrings-file-creation

Conversation

seratch
Copy link
Member

This pull request adds a new script for docs, which generates missingref/**/*.md files. The script can be executed when you runmake 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 liketool_context toTool Context.openai_provider will beOpenai Provider, so some of them needs a little manual work to adjust.

The direct need is to addtool_context.md for#1043 but it should be useful for future maintenance.

@seratchseratch requested a review fromrm-openaiJuly 10, 2025 03:30
@seratchseratch added the documentationImprovements or additions to documentation labelJul 10, 2025
Copy link
Collaborator

@rm-openairm-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

@seratch
Copy link
MemberAuthor

seratch commentedJul 14, 2025
edited
Loading

@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.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@rm-openairm-openairm-openai requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentationImprovements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@seratch@rm-openai

[8]ページ先頭

©2009-2025 Movatter.jp