-
Notifications
You must be signed in to change notification settings - Fork 340
[docs] lazydocs to mkdocstrings #1060
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
base: main
Are you sure you want to change the base?
Conversation
CodSpeed Performance ReportMerging #1060 will not alter performanceComparing Summary
|
| for file in Path(input_dir).rglob("*.md"): | ||
| output_file = file.with_suffix(".mdx").name | ||
| print(f"Processing {file} -> {output_file}") | ||
| parser.process_file(str(file), str(Path(input_dir) / "mintlify" / output_file)) |
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.
| (output_path / "index.mdx").write_text(readme_text) | ||
| readme_text = Path("README.md").read_text() | ||
| readme_text = header + readme_text | ||
| (output_path / "index.mdx").write_text(readme_text) |
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.
Bug: Inconsistent File Path Handling
The copy_readme function always writes index.mdx to a hardcoded path, while process_files uses a path derived from the input_dir argument. This inconsistency can lead to index.mdx being placed in a different output directory than other processed files when a custom input directory is used, potentially breaking the documentation build.
This PR migrates from
lazydocstomkdocstrings