2010-12-29 5 views
8

私は等の各モジュールのプロジェクト、sphinxインポートの親ディレクトリの最初のファイルですか?

、各モジュールを共有し、会社情報のようないくつかの共通のRSTS、ライセンス、

マイプロジェクトツリーは次のようである1つのスフィンクスを作成する必要があります。

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

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

私はこれを./device1/index.rstに書きますが、それはうまくいきません。どうすれば親の最初のファイルをインポートできますか?

.. toctree:: 
    :maxdepth: 1 

    ../intro 
    ../about 

答えて

6

私はこれを行うための方法が見つかりました:

.. include:: ../intro.rst 

をしかし、それはすべてのテキストが含まれます... 多分それは唯一の方法ですか?

+0

もう少し冗長な答えは、[このStackOverflow答え](http://stackoverflow.com/a/17217041/1398841)を参照してください。 – phoenix

+1

README.rstの一部のみを含める:https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/ – ederag

0

私は個人的には、ソースの検索パスを変更する方法を見つけ出すことができなかったので、私はスフィンクスのビルドディレクトリ内のすべての*.rstファイルに対するシンボリックリンクを作成するために、メイクファイルを変更することになりました。

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

(これは、Linux/Unixのを使用している前提としています。)

関連する問題