Skip to content

Conversation

@deven367
Copy link
Collaborator

@deven367 deven367 commented Oct 16, 2025

This PR does the migration from lazydocs to mkdocstrings

  • update Makefile
  • update build-docs workflow
  • add parser

@deven367
Copy link
Collaborator Author

@elephaint This PR is ready, but I can't figure the latex rendering issue from the docstrings, everything else looks good!

Copy link
Collaborator

@elephaint elephaint left a comment

Choose a reason for hiding this comment

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

Thanks @deven367 , great work! Mostly minor comments 👍

Copy link
Contributor

@nasaul nasaul left a comment

Choose a reason for hiding this comment

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

Great work @deven367! 🎉

Just a final comment: you've updated the installer for the build-docs however it doesn't install the dependecy when installing. Do you think that we should add this into the project.optional-dependencies inside the pyproject.toml?

Copy link
Collaborator

@elephaint elephaint left a comment

Choose a reason for hiding this comment

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

I think we should only address the formating issues on the main landing page, other than that I think it's good to go:

image

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@deven367
Copy link
Collaborator Author

deven367 commented Dec 1, 2025

I think we should only address the formating issues on the main landing page, other than that I think it's good to go

I've cleaned the readme rendering now! looks a lot cleaner :)
image

@deven367 deven367 requested a review from elephaint December 1, 2025 00:42
Copy link
Collaborator

@elephaint elephaint left a comment

Choose a reason for hiding this comment

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

This is great, one minor comment

elephaint
elephaint previously approved these changes Dec 1, 2025
Copy link
Collaborator

@elephaint elephaint left a comment

Choose a reason for hiding this comment

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

Great, thanks!!

@deven367 deven367 merged commit 5f6dedf into main Dec 1, 2025
21 checks passed
@deven367 deven367 deleted the lazydocs-to-mkdocstrings branch December 1, 2025 15:04
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.

4 participants