使用 README.rst 将 csv 表添加到 github

Question

所以 github 声称支持 README.md 文件的重组文本，这很好，因为我在 .csv 文件中有一份材料清单，我想通过以下方式添加到我的 README.rst:

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

但是，当我在 my repository 上查看页面时，我看到的只是标题（如预期的那样）和一些文本，而不是 table。此外，我不知道从哪里可以找到 github 的内部解析引擎的任何输出文件来帮助我找出问题所在。这在我的本地机器上使用 sphinx 构建时工作得很好（table 按预期嵌入）。这里的潜在问题是什么，我如何查看 github 的内部输出，这会为我提供有关问题所在的线索？

Answer 1

CSV 表是 Sphinx 风格的 rST 的一个特性，而不是普通的 Docutils rST。 GitHub 正在使用普通的。您必须在 GH 上使用简单表或网格表，请参阅 https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables

使用 README.rst 将 csv 表添加到 github

Adding csv tables to github using README.rst

restructuredtext

github