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

figure out how to autogenerate + load the contributing docs into the notebook #27

Open
void-elf opened this issue Jun 15, 2017 · 0 comments

Comments

@void-elf
Copy link
Contributor

Our contributing docs are currently located in two places: at the bottom of the notebook and in the README. Right now if we want to update those docs, we have to manually update them in both places.

It might be possible to make the notebook automagically load those docs into the document, while having them keep their nice formatting, which would make it easy to write a script to insert the docs in both places, and only have to edit them from one central location.

I played around with %load and %%markdown (https://ipython.org/ipython-doc/dev/interactive/magics.html#magic-load), but didn't get very far. There's also this: http://guido.vonrudorff.de/ipython-notebook-code-output-as-markdown/, which is close to what we want, but its output is a strange kind of markdown that doesn't look like the rest of the document.

This is a good volunteer task for someone who in interested in hacking Jupyter notebooks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant