Как использовать Intersphinx для связывания документов, когда основной домен изменится? - PullRequest
Новая
       9

Как использовать Intersphinx для связывания документов, когда основной домен изменится?

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

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

Все примеры, которые я вижу в Inte rnet, предполагают, что домен stati c будет в использовании и документация не копируется в новые места. Есть ли какой-нибудь способ легко учесть изменение домена?

Еще одна проблема, которая может охватывать предыдущую, - это относительные ссылки. Можем ли мы учесть изменение домена таким образом, чтобы мне не пришлось перестраивать документы? В HTML я бы имел ссылки на «/some/page.html» вместо «http://example.com/some/page.html».

1 Ответ

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

Похоже, вы просто хотите использовать относительные пути вместо доменных имен. Если это так, вы должны сделать что-то подобное в вашем conf.py:

intersphinx_mapping = {
    'other': ('example/', 'example/example.inv'),
}

Из документов intersphinx extension :

Относительные локальные пути для целевых местоположений берутся относительно базы построенной документации, а относительные локальные пути для местоположений инвентаря берутся относительно исходного каталога.

...