如何将 intersphinx 链接到 django 特定的结构（如设置）？

Question

通过适当的 intersphinx 设置，您可以从自己的文档中链接到 Django 类，如下所示：

:class:`django:django.db.models.Model`

但是如何链接到设置？ Django 使用它自己的:setting: 构造，而不是像:class: 这样的内置构造。如何使用 intersphinx 链接到设置？

我尝试了各种咒语，但都没有奏效（有些可能是完全错误的）：

:ref:`django:ROOT_URLCONF`
:ref:`django:root_urlconf`
:setting:`django:ROOT_URLCONF`
:ref:`django:setting:ROOT_URLCONF`
:django:setting:`ROOT_URLCONF`

undefined label: django:root_urlconf 和 Unknown interpreted text role "setting" 之类的错误欢迎我。

Answer 1

问题：我的本地 sphinx 不知道 Django 的自定义 sphinx 角色，例如 setting。所以像这样一个完美的 intersphinx 参考：

:django:setting:`ROOT_URLCONF`

在您将 intersphinx 目标的自定义角色告知 Sphinx 之前，它不会起作用。

最后通过从Django's sphinx extension 复制一个小的sn-p 作为我的文档旁边的_ext/djangodocs.py 使其工作：

def setup(app):
    app.add_crossref_type(
        directivename = "setting",
        rolename = "setting",
        indextemplate = "pair: %s; setting",
    )

我将以下内容添加到我的 Sphinx'conf.py:

import os
import sys

...

sys.path.append(
    os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
# ^^^ I'll do that neater later on.

extensions = ['djangodocs',
              # ^^^ I added that one.
              'sphinx.ext.autodoc',
              ...
              ]

...

所以：intersphinx 有效，但如果您指向自定义角色，则需要在本地定义该自定义角色。

Answer 2

您需要查看 django 的 objects.inv 以确定正确的交叉引用应该是什么。

看来：

:std:setting:`ROOT_URLCONF <django:ROOT_URLCONF>`

应该可以。

不知何故，我有 django 的 objects.inv，但找不到我从中检索到的 URL，理论上它应该是 https://docs.djangoproject.com/en/1.4/objects.inv，但重定向多次最终导致文件未找到错误。