search

BiomedSciAI / fuse-med-ml

A python framework accelerating ML based discovery in the medical field by encouraging code reuse. Batteries included :)
Apache License 2.0
134 stars 34 forks source link

Added readthedocs config for documentation #339

Closed rakesh9177 closed 8 months ago

rakesh9177 commented 9 months ago

Readthedocs is configures, whenever a commit happens, it will update the docs automatically, make sure to update the readme.md file if new instructions are needed.

Please create an account on readthedocs and add your repo to publish the docs

rakesh9177 commented 9 months ago

Hi @SagiPolaczek , Please let me know if anything is required on this. Thank you!

SagiPolaczek commented 9 months ago

@rakesh9177 Awesome, thanks! And sorry for the delay, had to be afk for couple of days. Will add a review comment now :)

rakesh9177 commented 9 months ago

Hi @SagiPolaczek ,

Thanks for the review, I updated the conf.py file as per mypy.

The landing page for modules requires a Readme.md file within each module package. we can do this by including the path of readme.md file in rst files. I see there is one for fuseimg but there isn't one for fuse package. Although there is a Readme.md inside fuse.dl, do you want to me to use that for fuse package or I just use fuse.dl as a package and use readme.md file for documentation for this?

Thanks again!

rakesh9177 commented 9 months ago

Thank you for the review and tips @SagiPolaczek !

There are two ways to add readme file to rst file.

1)Manually add text like ".. mdinclude:: ../../fuse/dl/README.md" to rst files 2)To do an os.walk() and it will search for README file and then add to to their respective rst files.

I am not sure why we would want to delete the below code because it is being appended to rst files when doing and os.walk() INCLUDE_TEXT = ".. mdinclude:: "

But If we want to use approach 1, we can remove all that code in conf.py which automatically links Readme to rst files.

Thanks!

SagiPolaczek commented 9 months ago

@rakesh9177 My bad, I wasn't clear enough - I meant to delete the comment(s) and the actual code. Thanks for verifying that :) That's not a must, I just like don't like artifacts from previous changes.

And thanks for the explanation! That's clear now.

SagiPolaczek commented 8 months ago

Thanks @rakesh9177 ! I review the changes and it looks good to me! I'll approve and merge your PR later on today. Please let me know if you planned any extra change.

FYI, I've opened an account on readthedocs, but before launching the repo's website I need to get permissions from my org admin.

rakesh9177 commented 8 months ago

Great @SagiPolaczek , I have no plans to add extra changes. Thank you!

SagiPolaczek commented 8 months ago

@rakesh9177 Thanks for your contribution :)