Skip to content

Conversation

@deven367
Copy link
Collaborator

@deven367 deven367 commented Oct 16, 2025

Description

This PR migrates away from lazydocs to mkdocstrings

Checklist:

  • This PR has a meaningful title and a clear description.
  • The tests pass.
  • All linting tasks pass.
  • The notebooks are clean.

@elessar-for-github
Copy link

Changes made by this pull request:

.github/workflows/build-docs.yaml
[Error processing diff]

Makefile
[Error processing diff]

docs/auto.html.md
[Error processing diff]

docs/callbacks.html.md
[Error processing diff]

docs/convert_to_mkdocstrings.py
[Error processing diff]

docs/core.html.md
[Error processing diff]

docs/distributed.forecast.md
[Error processing diff]

docs/distributed.models.dask.lgb.html.md
[Error processing diff]

docs/distributed.models.dask.xgb.html.md
[Error processing diff]

docs/distributed.models.ray.lgb.html.md
[Error processing diff]

docs/distributed.models.ray.xgb.html.md
[Error processing diff]

docs/distributed.models.spark.lgb.html.md
[Error processing diff]

docs/distributed.models.spark.xgb.html.md
[Error processing diff]

docs/feature_engineering.html.md
[Error processing diff]

docs/forecast.html.md
[Error processing diff]

docs/grouped_array.md
[Error processing diff]

docs/lag_transforms.html.md
[Error processing diff]

docs/lgb_cv.html.md
[Error processing diff]

docs/mintlify/mint.json
[Error processing diff]

docs/optimization.html.md
[Error processing diff]

docs/target_transforms.html.md
[Error processing diff]

docs/to_mdx.py
[Error processing diff]

docs/utils.html.md
[Error processing diff]

(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)
Copy link

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.

Fix in Cursor Fix in Web

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))
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: MDX Writing Fails Without Directory Check

The process_files function attempts to write MDX files to the mintlify subdirectory without ensuring the directory exists first. This can lead to a FileNotFoundError if the mintlify directory is missing when parser.process_file tries to write.

Fix in Cursor Fix in Web

@codspeed-hq
Copy link

codspeed-hq bot commented Oct 16, 2025

CodSpeed Performance Report

Merging #519 will not alter performance

Comparing lazydocs-to-mkdocstrings (9ab02b8) with main (c2cafae)

Summary

✅ 12 untouched

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants