Skip to content
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.

Sign up for GitHub

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

Jump to bottom

create documentation project on Read the Docs #189

Open
SagiPolaczek opened this issue Oct 6, 2022 · 7 comments
Open

create documentation project on Read the Docs #189

SagiPolaczek opened this issue Oct 6, 2022 · 7 comments
Assignees
@rakesh9177
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@SagiPolaczek
Copy link
Collaborator

Hey!
This issue aims to added documentation for FuseMedML using Read the Docs automating building.

Currently we have this, which is clearly irrelevant. The end goal is to have Fuse's documentation nicely documented on Read the Docs to help AI researchers get started with our tools.
Please visit here for a good example.

Also note that the badge Documentation Status should be 'passing'.

References
See casualib library and their read the docs.
Read the Docs website



Please feel free to participate and solve that issue.
Happy Coding !
@SagiPolaczek SagiPolaczek added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 6, 2022
@Sai-Suraj-27
Copy link

Hi, @SagiPolaczek Can I work on this issue?

@SagiPolaczek
Copy link
Collaborator Author

Hey @Sai-Suraj-27 ,
Yes that will be great!

@rakesh9177
Copy link
Contributor

Hi @SagiPolaczek , Is this issue still open? If you would like, I can create a pull request by tomorrow for documentation. I already did complete most of it- https://fuseml.readthedocs.io/en/latest/index.html

@SagiPolaczek
Copy link
Collaborator Author

@rakesh9177
Yes it is.
A PR will be great 😄

@rakesh9177
Copy link
Contributor

rakesh9177 commented Dec 21, 2023 •
edited
Loading

Hi @SagiPolaczek , I created a PR, please review and let me know if it is good or need any changes

PR - #339

@SagiPolaczek
Copy link
Collaborator Author

SagiPolaczek commented Jan 4, 2024 •
edited
Loading

The badge that induced by your changes: 😄
Documentation Status

@hichem-18
Copy link

Hi is this issue still available?

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

@rakesh9177 rakesh9177

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@SagiPolaczek @hichem-18 @Sai-Suraj-27 @rakesh9177