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.

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

Render Jupyter notebooks inside the Scribe-Data documentation #210

Closed
2 tasks done
andrewtavis opened this issue Oct 3, 2024 · 11 comments
Closed
2 tasks done

Render Jupyter notebooks inside the Scribe-Data documentation #210

andrewtavis opened this issue Oct 3, 2024 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation feature New feature or request hacktoberfest Included as a part of Hacktoberfest help wanted Extra attention is needed

Comments

@andrewtavis
Copy link
Member

Terms

Description

As of now the Scribe-Data documentation just presents a link to Jupyter notebooks as is seen on readthedocs.io:scribe_data/wikipedia/gen_autosuggestions.html. There is an option to render Jupyter notebooks in Sphynx documentation. This issue would add this functionality to our docs :)

Contribution

This would be a great issue for someone to work on! Happy to answer questions, support as needed and review when a PR is up 😊

@andrewtavis andrewtavis added documentation Improvements or additions to documentation feature New feature or request help wanted Extra attention is needed hacktoberfest Included as a part of Hacktoberfest labels Oct 3, 2024
@AnishereMariam
Copy link
Contributor

@andrewtavis, I'll pick this one up :)

@andrewtavis
Copy link
Member Author

Thanks for your willingness to help, @AnishereMariam!

@andrewtavis
Copy link
Member Author

Checking in with you here @AnishereMariam :) Do you need some support?

@AnishereMariam
Copy link
Contributor

@andrewtavis, thank you for checking up. I have been able to fix this. I will raise a PR on it.

@andrewtavis
Copy link
Member Author

Nice, @AnishereMariam! :)

@Khushalsarode
Copy link
Contributor

shall we work this? @AnishereMariam

@AnishereMariam
Copy link
Contributor

I have rendered the notebook. I am raising a PR on it. The bug slowed me down a bit but I can show you what I've done so far @Khushalsarode. Let's link up on Matrix

@Khushalsarode
Copy link
Contributor

Sure

@andrewtavis
Copy link
Member Author

Let us know if there's anything else we can do to support, @AnishereMariam! :)

@AnishereMariam
Copy link
Contributor

Hi @andrewtavis, I raised a PR regarding this issue: #463. It was pretty challenging, lol. I would really appreciate your feedback on the PR.

@andrewtavis
Copy link
Member Author

I think we're all done here for this initial issue. For further work we can make a new issue :) Let us know if you have suggestions, @AnishereMariam!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request hacktoberfest Included as a part of Hacktoberfest help wanted Extra attention is needed
Projects
Status: Done
Development

No branches or pull requests

3 participants