Проблемы создания ссылок intersphinx для локальных файлов в нескольких проектах - PullRequest
0 голосов
/ 31 мая 2019

У меня есть несколько разных проектов sphinx, которые я хотел бы ссылать друг на друга локально (без веб-сервера). У меня есть отдельная настройка кода + сборки каталогов для проектов, и я пытался intersphinx решить это требование.

Мои вопросы:

1) Есть ли лучший способ сослаться на два или более локальных проекта в Sphinx?

2) Есть ли способ вырезать вторую сборку на пути?

В моем конфигурационном файле у меня есть:

intersphinx_mapping = {
'doc1': ('../build/doc1',None)
}

, поэтому у меня нет проблем с созданием html-кода, однако, когда я смотрю на ссылку, созданную с помощью :ref:'doc1 info <doc1:label1>', у меня есть в html-документе:

Файл: ////build/build/doc1/html/doc.html#label1

Таким образом, проблема в том, что я получаю два списка компоновки директории - это должно быть так: файл: ////build/doc1/html/doc.html#label1.

Если я сделаю это вручную, документ будет правильно загружен.

Я также пытался заменить None на '../build/doc1'. Если я удаляю сборку из сопоставления, я получаю ошибку при поиске файла objects.inv для doc1.

Я не хочу использовать абсолютный путь, так как конечный пользователь, получающий эту документацию, может увидеть ее в другом месте, и я хочу, чтобы она была кроссплатформенной ...

Мое дерево каталогов выглядит следующим образом:

Makefile
build/doc1/html
build/doc2/html
doc1
doc2

В качестве фона я пытаюсь сделать это под Cygwin со Sphinx 1.7.5 ... Я еще не пробовал Linux, чтобы увидеть, получаю ли я такое же поведение ...

Спасибо за внимание.

...