I noticed that the table in /ports/esp32s2/README.md isn't rendered correctly on readthedocs.io. This is a common problem with using recommonmark with sphinx. The recommonmark docs recommend using embedded rst syntax for tables.
Converting the
| GPIO | USB |
| ---- | ----------- |
| 20 | D+ (green) |
| 19 | D- (white) |
| GND | GND (black) |
| 5V | +5V (red) |
to
```eval_rst
.. csv-table::
:header: GPIO, USB
20, "D+ (green)"
19, "D- (white)"
GND, "GND (black)"
5V, "+5V (red)"
.```
but without the . preceding the closing ``` because I had trouble getting github to render the example properly in this posting. You don't have to use csv-table syntax; I just find it easier than getting all the cells' delimiters to vertically match up.
Of course this change would render weird when viewed in github, but what's more important docs or github? The alternative to have the table rendered properly in both github and readthedocs.io would be to convert the entire readme into rst syntax (which is not hard).
I noticed that the table in /ports/esp32s2/README.md isn't rendered correctly on readthedocs.io. This is a common problem with using recommonmark with sphinx. The recommonmark docs recommend using embedded rst syntax for tables.
Converting the
to
but without the
.preceding the closing```because I had trouble getting github to render the example properly in this posting. You don't have to use csv-table syntax; I just find it easier than getting all the cells' delimiters to vertically match up.Of course this change would render weird when viewed in github, but what's more important docs or github? The alternative to have the table rendered properly in both github and readthedocs.io would be to convert the entire readme into rst syntax (which is not hard).