Блог

Итак, github утверждает, что поддерживает реструктурированный текст для README.md файл, и это здорово, потому что у меня есть спецификация в файле .csv, который я хотел бы добавить следующим образом в свой README.rst:

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

Однако, когда я просматриваю страницу в своем репозитории, все, что я вижу, это заголовок (как и ожидалось) и некоторый текст, но не таблицу. Кроме того, я не знаю, где найти какие-либо выходные файлы из внутреннего механизма синтаксического анализа github, чтобы помочь мне выяснить, в чем проблема. Это отлично работает при сборке с помощью sphinx на моем локальном компьютере (таблица встроена, как и ожидалось). В чем здесь потенциальная проблема и как мне просмотреть внутренние выходные данные github, которые дали бы мне представление о том, что происходит не так?

Таблицы CSV являются особенностью rST со вкусом Sphinx, а не простых документов rST. GitHub использует обычный. Вы должны использовать либо простые таблицы, либо таблицы сетки на GH, см. https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables