开发者

sphinx import parent dir rst file?

I need to create one sphinx project for each module,

and each module share some common rsts, like comp开发者_如何转开发any info, license, etc.

My project tree is like this:

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

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

I write this in ./device1/index.rst, and it is not worked, how could I import parent rst files?

.. toctree::
   :maxdepth: 1

   ../intro
   ../about


I found a way to do this:

.. include:: ../intro.rst

but it will include all the texts... maybe it is the only way?


I personally couldn't figure out how to modify the source search path, so I ended up modifying the make file to create symlinks for all *.rst files in the sphinx build directory.

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

(This presumes you're using Linux/Unix.)

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜