2010-05-27 4 views
11

(en utilisant l'outil de documentation Python-Sphinx)Inclure un fichier texte * est * comme dans (Python) Sphinx Docs

J'ai un fichier journal .txt Je voudrais construire en _build/htmlnon modifiée. Que dois-je modifier dans conf.py, index.rst, etc.

Voici la mise en page:

src/ 
    index.rst 
    some_doc.rst 
    somefile.txt 

Comment puis-je obtenir somefile.txt dans la construction html? J'ai essayé d'ajouter une ligne comme celle à index.rst:

Contents: 

.. toctree:: 
    :maxdepth: 2 

    some_doc 
    "somefile.txt" 

espérant qu'il travaillerait par magie, mais pas de magie ici!

En supposant que cela soit encore possible, que dois-je mettre some_doc.rst pour faire référence/lier à ce fichier?

Remarque Oui, je sais que je pourrais le mettre dans /statique et juste être fait avec elle, mais qui semble comme un hack total et laid.

Répondre

8
+3

Comment l'ajout d'un lien de téléchargement est-il la réponse à la question «comment intégrer un fichier dans un fichier non modifié? – mabraham

+0

Le lien de la liste de diffusion dans la réponse est mort. Est-ce le message auquel vous faites référence? https://groups.google.com/d/msg/sphinx-users/LZzb8wlAoSs/FHU1eN6RMBAJ – mzjn

14

Je pense que vous pouvez inclure un fragment de document externe, tel que décrit ici:

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

A partir de ce texte, quelque chose comme ça devrait le faire:

.. include:: inclusion.txt 
    :literal: 
+1

pas tout à fait ce que je veux, mais je suis à la recherche sur: premières: et d'autres rôles. Je n'essaie pas d'inclure un "fragment", mais apporte un fichier while * tel quel *, donc je peux le lier, un la -> si vous regardez le 'log ' _ .... –

+1

this répond au titre de la question, ce qui suggère une question complètement différente ;-) – odony

Questions connexes