2010-12-29 5 views
8

Necesito crear un proyecto esfinge para cada módulo,sphinx import parent dir primer archivo?

y cada acción módulo de algunas RSTs comunes, como la información de la empresa, licencia, etc.

Mi árbol del proyecto es la siguiente:

./conf.py 
./index.rst 
./intro.rst 
./about.rst 

./device1/conf.py 
./device1/index.rst 

Escribo esto en ./device1/index.rst, y no funciona, ¿cómo puedo importar los primeros archivos principales?

.. toctree:: 
    :maxdepth: 1 

    ../intro 
    ../about 

Respuesta

6

he encontrado una manera de hacer esto:

.. include:: ../intro.rst 

pero incluirá todos los textos ... quizá ¿Es la única forma?

+0

Consulte [esta respuesta de StackOverflow] (http://stackoverflow.com/a/17217041/1398841) para obtener una respuesta un poco más detallada. – phoenix

+1

Para incluir solo una parte de README.rst: https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/ – ederag

0

personalmente no podía encontrar la manera de modificar la ruta de búsqueda de origen, por lo que terminó modificando el archivo de maquillaje para crear enlaces simbólicos para todos los *.rst archivos en el directorio de la esfinge de construcción.

foreach f (`\ls OTHER_DIR | egrep '.rst$$'`) \ 
    ln -s -f $$f BUILD_DIR \ 
end 

(Esto supone que está utilizando Linux/Unix.)