Включить текстовый файл * как есть * в (Python) Sphinx Docs

Question

(с помощью инструмента документации Python-Sphinx)

У меня есть .txt файл журнала, который я хотел бы встроить в _build/html без изменений . Что мне нужно изменить в conf.py, index.rst и т. Д.

Вот макет:

src/
    index.rst
    some_doc.rst
    somefile.txt

Как мне вставить somefile.txt в сборку html? Я попытался добавить такую ​​строку до index.rst:

Contents:

.. toctree::
   :maxdepth: 2

   some_doc
   "somefile.txt"

надеясь, что это сработает магией, но никакой магии здесь!

Предполагая, что это даже возможно, что бы я положил в some_doc.rst для ссылки / ссылки в этот файл?

Примечание Да, я знаю, я мог бы поместить это в / static и просто покончить с этим но это кажется полным взломом и безобразным.

Answer 1

Я думаю, что вы можете включить внешний фрагмент документа, как описано здесь:

http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment

Из этого текста что-то вроде этого должно сделать:

.. include:: inclusion.txt
   :literal:

Answer 2

Правильный ответ: :download: роль .

Cf: Ответ Георга в списке рассылки Сфинкса