Closed clemens-fricke closed 3 weeks ago
[!IMPORTANT]
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yaml
file in this repository. To trigger a single review, invoke the@coderabbitai review
command.You can disable this status message by setting the
reviews.review_status
tofalse
in the CodeRabbit configuration file.
This update significantly enhances the markdown handling capabilities of the project. The process_file
function has been optimized for memory efficiency by processing files line by line, while a new function, prepare_file_for_PyPI
, facilitates the conversion of relative links for distribution purposes. Additionally, the pyproject.toml
file is updated to automate the README preparation during the build process, ensuring that documentation is always up to date before builds.
File | Change Summary |
---|---|
docs/source/handle_markdown.py |
Refactored process_file for line-by-line reading; added prepare_file_for_PyPI function. |
pyproject.toml |
Added before_all command to execute markdown processing script before the build process. |
🐰 In the garden where docs grow bright,
Markdown blooms, a wonderful sight!
With new paths and links, all set to soar,
Build the future, let knowledge pour!
A hop and a skip, we celebrate today,
For every change, a better way! 🌼✨
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Overview
On PyPi, the readme has no images/only a few images show up. With these changes, this should not happen anymore.
Addressed issues
Checklists
Summary by CodeRabbit
New Features
Improvements