executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
759 stars 196 forks source link

Move/remove htop image and show plots on wealth dynamics example page #321

Open joelostblom opened 3 years ago

joelostblom commented 3 years ago

There is a picture of htop showing parallel CPU utilization at the rst and MyST versions of the wealth dynamics examples page, but it seems to be in the wrong location on the page. Maybe it should be moved just under to one of the previous sentences talking about parallelization?

The plots on this page are also not showing in the rendered book.

https://myst-parser.readthedocs.io/en/latest/examples/wealth_dynamics_rst.html#inequality-measures

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

choldgraf commented 3 years ago

LOL that is a weird docs bug indeed. Maybe @mmcky could advise on this one? I think the ANU team put together these examples.

mmcky commented 3 years ago

thanks @joelostblom -- time to take a look at that.

@choldgraf I have been keeping my eye on this demo / example set

mmcky commented 3 years ago

this is what the example is based off of but it looks like it is an incomplete translation. I will look at updating this later today

https://python.quantecon.org/wealth_dynamics.html

the goods news is the image is in the correct location (according to the source files :-))

mmcky commented 3 years ago

Looking at the history on this -- I don't think it was ever intended to be the full example lecture but serve to demonstrate elements of a document comparing rst and md. The rst file here is the same as the md file so it is a "correct" translation but doesn't make sense to read through it.

I will still update this with the complete lecture so this isn't registered as a bug -- as it is a bit confusing (for readers)

chrisjsewell commented 3 years ago

@choldgraf is there a reason you changed the label from documentation to bug? this just requires a change to the documentation yes?