Code-generated Markdown tables do not render correctly

[tsalo]

This is a known issue in MyST-NB. I want to figure out a workaround.

[tsalo]

Here's an example: https://bids-standard.github.io/bids-specification-ignore/src/03-modality-agnostic-files.html#dataset-description-json

[effigies]

If you copy-paste the generated markdown in for one of the tables, does it render correctly? Is it possible that we're not generating the correct markdown?

[tsalo]

If I copy the to_markdown() output to the file directly, it will render correctly. The problem is when I try to display the code-cell output. The relevant MyST-NB issue is executablebooks/MyST-NB#322.

[effigies]

Can we render to RST or HTML?

[tsalo]

I was planning to try HTML. Hadn't thought of trying RST.

[tsalo]

I think one reasonable solution might be to use pandas Styling, like here. We'll need to figure out the optimal formatting for our tables though...

[tsalo]

One idea of @effigies' that seems to work is

display(HTML(markdown(table.to_markdown(), extensions=['tables'])))

The thing I'm stuck on now is including glossary links in the table. For example, having the string {term}`Name (metadata)` ends up looking like

in the rendered table.

[effigies]

Here's a nuts idea:

display(Markdown(markdown(table.to_markdown(), extensions=['tables'])))

Probably won't work since the outer markdown will interpret the HTML as hands-off...

[tsalo]

Just tried it out, and the result was the same as the HTML version.

[effigies]

I don't know the Markdown object well enough, but if we could invert this like markdown(Markdown(...), extensions=['tables']), that might work.

[tsalo]

I tried writing a function that would replace {term}<code>...</code> with {term}`...`. The HTML string does end up having the {term}`...` I want, but it looks like the glossary links must be rendered before the table is displayed?

Even having display(Markdown("{term}Manufacturer (metadata)")) in a code cell didn't work.

EDIT: I've opened #8 about this problem.

I don't know the Markdown object well enough, but if we could invert this like markdown(Markdown(...), extensions=['tables']), that might work.

This didn't work. markdown() requires a string.

[effigies]

It looks like we can use .to_markdown(tablefmt=...) for values listed in https://github.com/astanin/python-tabulate#table-format, which includes 'rst'. So might be worth seeing if converting to RST would be easier than hacking myst to render markdown tables.