githubrestructuredtext

Adding csv tables to github using README.rst

GitHub claims reStructuredText support in README.md; I'd like to add a .csv file in README.rst:

.. csv-table::
    :widths: 25 25 25 25
    :file: bom.csv

In my repository, I see the heading (as expected), and some text, but not the table. It works when building with sphinx on my machine. What's the issue, and how do I view GitHub's parsing engine logs to debug?

Solution

  • CSV tables are a feature of the Sphinx-flavoured rST, not the plain Docutils rST. GitHub is using plain. You have to use either simple or grid tables on GH, see https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables