Создание таблиц в sphinx при использовании ресурсов из markdown

Я создаю свой документ SphinX из исходного файла MarkDown, то есть в моем файле index.rst, который у меня есть:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   myMarkDownText
.
.
.

в котором myMarkDownText судит myMarkDownText.md

Я попытался создать таблицу из этого исходного файла MarkDown в обоих следующих форматах:

| Name            | Age   |
| :---            |  ---: |
| John D Hunter   | 40    |

где находится в синтаксисе MD, и

==================   ============
Name                 Age
==================   ============
John D Hunter        40
==================   ============ 

где находится в синтаксисе RST.

Кажется, что ни один из них не создает форму таблицы в моем выходном index.html SphinX, когда я создаю его с помощью:

make html

Знаете ли вы какой-либо другой формат / способ, который я должен попробовать?

PS_ Обратите внимание, я может создаю таблицы в хорошей форме, если помещаю свою таблицу в свой index.rst в моем SphinX. Но это не мой вопрос. Мой вопрос заключается в создании таблиц в SphinX при использовании исходных файлов .md.

Спасибо!

0
0
718
2

Ответы 2

Синтаксис таблиц - это нестандартное расширение Markdown, которое не поддерживается реализацией, используемой Sphinx. Следовательно, это кажется невозможным.

Согласно документация, Sphinx использует рекомендовать для анализа документов Markdown, который является реализацией Markdown CommonMark. Как вы можете видеть в спецификации CommonMark, таблицы являются поддерживаемой функцией нет. Для полноты заметьте, что таблицы также не были частью исходного Правила уценки. Кроме того, обзор опции, доступный в рекомендациях, указывает на отсутствие дополнительной поддержки для включения таблиц.

Возможно, существует альтернативная реализация Markdown с мостом Docutils, но я сам ничего не знаю (и рекомендовать библиотеки здесь не по теме).

Плагин столы уценки сфинкса позволяет получить таблицу в sphinx при поиске из уценки с использованием recommonmark.

Другое решение - поместить вашу таблицу в файл csv и использовать встроенная интеграция файлов csv в формате RST. Если вы исходите из уценки с recommonmark, вы можете использовать опцию eval_rst для оценки вашего первого фрагмента, док здесь

Решение 2 имеет то преимущество, что оно является встроенным, тогда как решение 1 проще после настройки, поскольку вам не нужно иметь дело с дополнительными файлами и проблемами с абсолютным / относительным путем.

Другие вопросы по теме