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

(с использованием инструмента документации 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 и просто покончить с этим, но это похоже на полный хак и уродство.


person Gregg Lind    schedule 27.05.2010    source источник


Ответы (2)


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

http://docutils.sourceforge.net/docs/ref/rst/directives.html#включая-an-external-document-fragment

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

.. include:: inclusion.txt
   :literal:
person djc    schedule 27.05.2010
comment
не совсем то, что я хочу, но я присматриваюсь к :raw: и другим ролям. Я не пытаюсь включать фрагмент, но привожу файл как есть, чтобы я мог ссылаться на него, а-ля -› если вы посмотрите на log <mylog.txt>_ .... - person Gregg Lind; 27.05.2010
comment
это действительно отвечает на заголовок вопроса, который намекает на совершенно другой вопрос ;-) - person odony; 04.03.2016

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

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

person Gregg Lind    schedule 28.05.2010
comment
Как добавление ссылки для скачивания является ответом на вопрос о том, как создать файл без изменений? - person mabraham; 13.01.2015
comment
Ссылка на список рассылки в ответе мертва. Это то сообщение, на которое вы ссылаетесь? groups.google.com/d/msg/sphinx-users/LZzb8wlAoSs/ FHU1eN6RMBAJ - person mzjn; 23.07.2015