Сфинкс - эффективная ссылка на файлы.rst вне дерева?

Я хочу собрать документацию Sphinx для проекта со структурой, подобной этой:

doc:
    index.rst
    conf.py
    Makefile
modules:
    module1:
        README.rst
    module2:
        README.rst

Я хотел бы легко включить предыдущие файлы README.rst в мою документацию по Sphinx.

Однако я прочитал здесь, что мне нужно создать пустышку link_to_readme.rst файлы с .. include:: ../modules/module1/README.rst Директива для достижения этой цели. Таким образом, дерево будет выглядеть так:

doc:
    modules:
        link_to_module1.rst
        link_to_module2.rst
    index.rst
    conf.py
    Makefile
modules:
    module1:
        README.rst
    module2:
        README.rst

Я нахожу это очень неэффективным, создавая много дополнительных файлов. С Doxygen можно просто сделать @subpage <tag> и соответствующий файл будет автоматически включен. Разве подобная функциональность не поддерживается в Sphinx? Это похоже на взлом для создания этих первых файлов...

0 ответов

Другие вопросы по тегам