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

✨ Add Jupyter notebook support to Documentation #447

Closed
1 of 4 tasks
keithrfung opened this issue Sep 24, 2021 · 3 comments · Fixed by #450
Closed
1 of 4 tasks

✨ Add Jupyter notebook support to Documentation #447

keithrfung opened this issue Sep 24, 2021 · 3 comments · Fixed by #450
Assignees
@abxhr @DireWolf707
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Issues for the Hacktoberfest help wanted Extra attention is needed
Milestone
🦖 Bowser Jr. v1.3.0

Comments

@keithrfung
Copy link
Collaborator

keithrfung commented Sep 24, 2021 •
edited
Loading

Is there an existing issue for this?

  • I have searched the existing issues

Suggestion

MkDocs has a plugin that support Jupyter notebooks. This would be really helpful in creating explanations.

See:
https://github.com/danielfrg/mkdocs-jupyter
https://jupyter.org/

Possible Implementation

  • Add plugin to mkdocs.yml
  • Add plugin to MakeFile install-mkdocs
  • Convert docs/0_Configure_Election.md to a Jupyter Notebook page (.ipynb) . This will likely have to install the package.

Anything else?

MakeFile install
https://github.com/microsoft/electionguard-python/blob/eb19846cd17ae73064586da8f0be11d97c565b43/Makefile#L146-L148

Ensure the file works by
make docs-serve
@keithrfung keithrfung added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed hacktoberfest Issues for the Hacktoberfest and removed enhancement New feature or request labels Sep 24, 2021
@abxhr
Copy link
Contributor

abxhr commented Sep 27, 2021

I would love to work on this! 🙋‍♂️

@abxhr abxhr mentioned this issue Sep 28, 2021
Merged
@DireWolf707
Copy link

Is this issue taken? Or i can take it ?

@keithrfung
Copy link
Collaborator Author

@DireWolf707
Currently, @abxhr is working on it but seems to be stuck. Perhaps take a look at their open PR and see if you can help? I'll assign both of you. There will be more pages to be converted assuming this one goes well.

@keithrfung keithrfung added this to the 🦖 Bowser Jr. v1.3.0 milestone Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abxhr abxhr

@DireWolf707 DireWolf707

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Issues for the Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
🦖 Bowser Jr. v1.3.0
Development

Successfully merging a pull request may close this issue.

Add Jupyter Notebook Support abxhr/electionguard-python
3 participants
@keithrfung @abxhr @DireWolf707