Sphinx index.rst внутри каталога - PullRequest
Новая
       6

Sphinx index.rst внутри каталога

0 голосов
/ 28 февраля 2020

Путь к мастеру do c сборки Sphinx можно указать в conf.py. Однако этот путь к каталогу отражается в сгенерированном HTML и показывается, например, в Read The Docs как отсутствующий индекс. Я бы хотел использовать этот альтернативный путь для аккуратной структуризации моего проекта - чтобы конфигурация была на верхнем уровне, а документация была внутри src, но сборка по существу избавилась от него.

Итак, вот что у меня было ранее: 

docs
    conf.py
    index.rst
    things
        doc1.rst
        doc2.rst

Это работает, но когда много файлов добавляется на верхний уровень, это запутывается в make-файлах Sphinx et c. Я хотел бы иметь вместо этого: 

docs
    conf.py
    src
        index.rst
        things
            doc1.rst
            doc2.rst

, который строит, но index.html находится в build/html/src вместо build/html. Я был удивлен, не обнаружив никакой информации об этом, кроме того факта, что master_doc в conf.py контролирует местоположение и имя основного файла. Как я могу получить документацию для build/html?

1 Ответ

0 голосов
/ 29 февраля 2020

Существует опция для указания местоположения файла конфигурации: -c. 

# conf.py
master_doc = 'index'

# structure
docs
    conf.py
    src
        index.rst
        ...

Затем запустите sphinx-build -b html -c . src build/html. Однако это решение действительно нуждается в контроле над командой сборки, которая недоступна в Read The Docs. И кажется, что -c также не работает в собственных make-файлах Sphinx (с -M вместо -b).

...