未知的解释文本角色"setting"与 Django 文档字符串和狮身人面像

Question

我正在记录 djagno 2.2 应用程序。

django文档指定链接到设置为

Add :mod:`django.contrib.auth` to your :setting:`INSTALLED_APPS`...

在我的文档中，语句是

The length is defined in the :setting:`URL_ID_LENGTH`

使用 sphinx

生成文档时

make html

给出警告

:docstring of app.models.Class.function:4: WARNING: Unknown interpreted text role "setting".

我将sphinx.ext.intersphinx添加到 sphinx 的conf.py中。

Answer 1

根据Django文档，它具有自己的特定标记。

您需要将django conf.py的 djangodocs添加到您的：

中

extensions = [
    "djangodocs",
    'sphinx.ext.extlinks',
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
]

然后将djangodocs扩展文件放入您的docs/_ext/djangodocs.py。

最终以这样的方式导入其路径：

sys.path.append(abspath(join(dirname(__file__), "_ext")))