首页 > 解决方案 > 当底层域发生变化时,如何使用 Intersphinx 链接文档?

问题描述

我有一个离线场景中重构文本文档的用例。安装后它将从一个域移动到另一个域,并且通常无法访问 Internet。我假设狮身人面像的 HTML 输出。我有多个微服务项目,我希望能够使用 Intersphinx 在它们之间共享链接。这些项目将一起运行,浏览一个项目的人将可以访问其他项目。我希望它们总是可以安排在同一顶级域的项目文件夹中。

我在 Internet 上看到的所有示例似乎都假定将使用静态域并且文档不会复制到新位置。有什么方法可以轻松解决不断变化的域?

可能涵盖前面的另一个问题是相对链接。我们能否以不需要我重建文档的方式来解释域更改?在 HTML 中,我会有指向“/some/page.html”而不是“ http://example.com/some/page.html ”的链接。

标签: dnspython-sphinxrestructuredtext

解决方案


听起来您只是想使用相对路径而不是域名。如果是这样的话,你会在你的 conf.py 中做这样的事情:

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

intersphinx 扩展文档

目标位置的相对本地路径被视为相对于构建文档的基础,而库存位置的相对本地路径被视为相对于源目录。


推荐阅读