-
Couldn't load subscription status.
- Fork 107
[docs] lazydocs to mkdocstrings #519
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
|
Changes made by this pull request: .github/workflows/build-docs.yaml Makefile docs/auto.html.md docs/callbacks.html.md docs/convert_to_mkdocstrings.py docs/core.html.md docs/distributed.forecast.md docs/distributed.models.dask.lgb.html.md docs/distributed.models.dask.xgb.html.md docs/distributed.models.ray.lgb.html.md docs/distributed.models.ray.xgb.html.md docs/distributed.models.spark.lgb.html.md docs/distributed.models.spark.xgb.html.md docs/feature_engineering.html.md docs/forecast.html.md docs/grouped_array.md docs/lag_transforms.html.md docs/lgb_cv.html.md docs/mintlify/mint.json docs/optimization.html.md docs/target_transforms.html.md docs/to_mdx.py docs/utils.html.md |
| (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 Output Paths in Functions
The copy_readme function uses a hardcoded output path, unlike process_files which respects the input_dir argument. This inconsistency causes the generated documentation and the index.mdx (README) to be written to different output directories when a custom input directory is provided.
| 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.
CodSpeed Performance ReportMerging #519 will not alter performanceComparing Summary
|
Description
This PR migrates away from
lazydocstomkdocstringsChecklist: