2010-12-29 10 views
8

muszę utworzyć jeden projekt sfinks dla każdego modułu,sphinx import plik nadrzędny dir rst?

i każdy udział modułu pewne wspólne RSTS, jak informacje o firmie, licencji itp

Moje drzewo projekt jest tak:

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

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

Piszę to w ./device1/index.rst, i to nie działa, w jaki sposób mogę zaimportować macierzyste pliki rst?

.. toctree:: 
    :maxdepth: 1 

    ../intro 
    ../about 

Odpowiedz

6

znalazłem sposób, aby to zrobić:

.. include:: ../intro.rst 

ale będzie ona obejmować wszystkie teksty ... może to jedyny sposób?

+0

Sprawdź [odpowiedź StackOverflow] (http://stackoverflow.com/a/17217041/1398841), aby uzyskać nieco bardziej gadatliwą odpowiedź. – phoenix

+1

Aby uwzględnić tylko część pliku README.rst: https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/ – ederag

0

Ja osobiście nie mógł dowiedzieć się, jak zmodyfikować ścieżkę przeszukiwania źródła, więc skończyło się na zmodyfikowanie pliku make tworzyć dowiązania dla wszystkich *.rst plików w katalogu sfinks kompilacji.

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

(ta zakłada, że ​​używasz Linux/Unix).

Powiązane problemy