Include a text file as is in (Python) Sphinx Docs

Question

(using Python-Sphinx Documentation tool)

I have a .txt log file I'd like to build into _build/html unaltered. What do I need to alter in conf.py, index.rst, etc.

Here is the layout:

src/
    index.rst
    some_doc.rst
    somefile.txt

How do I get somefile.txt into the html build? I tried adding a line like this to index.rst:

Contents:

.. toctree::
   :maxdepth: 2

   some_doc
   "somefile.txt"

hoping it would work by magic, but no magic here!

Assuming this is even possible, what would I put in some_doc.rst to refer/link to that file?

Note Yes, I'm aware I could put it in /static and just be done with it, but that seems like a total hack, and ugly.

djc djc · Accepted Answer · 2010-05-27T14:27:48

I think you can include an external document fragment, as described here:

From that text, something like this should do it:

.. include:: inclusion.txt
   :literal:

Include a text file *as is* in (Python) Sphinx Docs