Как добавить электронную таблицу в Read the Docs?

Как лучше всего добавить электронную таблицу в мою документацию с помощью Read the Docs?

Я работаю над проектом с открытым исходным кодом, который производит аппаратное и программное обеспечение с открытым исходным кодом. Вездесущий раздел документации по проектам аппаратного обеспечения с открытым исходным кодом — это раздел Bill of Materials, который обычно поставляется в виде электронной таблицы, в которой перечислены детали или сырье, которые необходимо приобрести для создания аппаратного продукта. Каждая строка электронной таблицы BOM содержит как минимум имя/идентификатор товара, количество, гиперссылку на то, где его можно приобрести, и цену товара.

В конце спецификации обычно указывается общая цена, представляющая собой сумму (цена*кол-во) предыдущих строк.

Read the Docs поддерживает создание таблиц. Есть ли способ добавить строку в конец таблицы, чтобы одно поле в этой строке содержало формулу, используемую для получения значения этой ячейки при компиляции документации? В идеале так, чтобы не требовался javascript на стороне клиента?

Или, в более общем плане, поддерживает ли Read the Docs добавление электронных таблиц в свою документацию?


person Michael Altfield    schedule 01.07.2020    source источник
comment
Из этого руководства об использовании таблиц в sphinx/rtd: CSV также можно управлять во внешнем файле. Это позволяет вам управлять своими сложными таблицами в стороннем инструменте, а ваша документация использует их из CSV, что является гораздо более удобным рабочим процессом ericholscher.com/blog/2016/jul/1/sphinx-and-rtd-for-writers/ Есть ли пример этого рабочего процесса где-нибудь?   -  person Michael Altfield    schedule 01.07.2020
comment
Что касается преобразования html в pdf ниже, pandoc может сделать это с помощью средства записи pdf, такого как pdflatex. См. SO questions/tagged/pandoc+pdf+html.   -  person denis    schedule 29.09.2020


Ответы (1)


Из коробки Sphinx не имеет возможности делать то, что вы хотите. Он может отображать статические таблицы из CSV. через синтаксис csv-table.

Однако вы можете встроить электронную таблицу, размещенную в стороннем сервисе, через raw.

.. raw:: html

    <iframe src="https://remote.sheet/filepath"></iframe>
person Steve Piercy    schedule 01.07.2020
comment
что будет установлено для встраивания, когда документация будет преобразована в файл PDF? - person Michael Altfield; 03.07.2020
comment
Разделы raw::html будут полностью пропущены для PDF. Я лично включаю raw::pdf с чем-то вроде Извините, но этот контент нельзя просмотреть в формате PDF. Вместо этого см. HTML-версию. - person Matt; 03.07.2020
comment
Ух ты! Я думал, может быть, iframe не будет отображаться в PDF, но весь html?!? Я удивлен, что кто-то не реализовал способ превратить html в PDF; не должно быть слишком сложно сделать.. - person Michael Altfield; 04.07.2020