Неизвестная интерпретируемая роль текста «сеттинг» с помощью Django docstring и Sphinx

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 к conf.py из Sphinx .

Answer 1

Согласно документации Django , она имеет собственную особую разметку.

Вам нужно добавить djangodocs из conf.py Django в вашу:

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

Затем поместите расширение djangodocs в ваш docs/_ext/djangodocs.py.

И, наконец, импортируйте его путь примерно так:

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