Come collegarsi con intersphinx a costrutti specifici di django (come le impostazioni)?

Question

Con una corretta impostazione intersphinx, è possibile collegare alle classi Django dalla propria documentazione come questo:

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

Ma come si fa a creare un collegamento a un ambiente? Django usa il suo costrutto :setting: invece di qualcosa di built-in come :class:. Come faccio a collegarmi a un'impostazione con intersphinx?

Ho provato vari incantesimi, ma nessuno di lavoro (e alcuni sono probabilmente semplicemente sbagliato):

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

errori come undefined label: django:root_urlconf e Unknown interpreted text role "setting" mi salutano.

Answer 1

Il problema: la mia sfinge locale non conosceva i ruoli personalizzati della sfinge di Django, come setting. Quindi un riferimento intersphinx perfettamente bene così:

:django:setting:`ROOT_URLCONF` 

non funziona fino a quando hai detto Sfinge sul ruolo personalizzato del bersaglio intersphinx.

Alla fine ottenuto che funziona copiando un piccolo frammento da Django's sphinx extension come _ext/djangodocs.py accanto alla mia documentazione:

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

E ho aggiunto il seguente alla mia 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', 
       ... 
       ] 

... 

Così : intersphinx funziona, ma se punti a un ruolo personalizzato, devi avere quel ruolo personalizzato definito localmente.

Answer 2

È necessario guardare gli oggetti.inv per django per capire quale dovrebbe essere il corretto riferimento incrociato.

sembra che:

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

dovrebbe funzionare.

In qualche modo ho gli oggetti.inv per django ma non riesco a trovare l'URL da cui l'ho recuperato, in teoria dovrebbe essere https://docs.djangoproject.com/en/1.4/objects.inv ma che reindirizza più volte alla fine risultando in un errore non trovato.