अन्य परियोजनाओं से लिंक¶
sphinx.ext.intersphinx से यहाँ न सुलझे संदर्भ दूसरे प्रोजेक्ट की इन्वेंटरी में खोजे जाते हैं। यह हर Sphinx या Guidedog साइट की objects.inv है। परियोजनाएँ conf.toml में दें:
extensions = ["sphinx.ext.intersphinx"]
[intersphinx_mapping]
python = ["https://docs.python.org/3/", ""]
click = ["https://click.palletsprojects.com/", ["click.inv", ""]]
हर प्रविष्टि दूसरे प्रोजेक्ट के पृष्ठों का पता और इन्वेंटरी की जगह देती है। यह URL, स्रोत फ़ोल्डर से सापेक्ष फ़ाइल या उस पते की objects.inv के लिए "" है। सूची क्रम से आज़माई जाती है। यह Sphinx का intersphinx_mapping है, Python के None की जगह "" के साथ। guidedog migrate इसे बदलता है।
फिर संदर्भों में नया कुछ नहीं चाहिए:
:func:`len`, :class:`list`, and :ref:`tut-packages` link into Python's documentation.
:ref:`click:testing` looks only in Click's inventory.
:external+python:ref:`tut-packages` never looks in this project.
लिंक दूसरे प्रोजेक्ट के लेबल और दस्तावेज़ के शीर्षक दिखाते हैं और “(in Python v3.14)” जैसा टूलटिप रखते हैं। Sphinx की तरह :doc: संदर्भ को परियोजना का नाम (:doc:`python:tutorial/index`) चाहिए, क्योंकि intersphinx_disabled_reftypes का डिफ़ॉल्ट ["std:doc"] है।
बिल्ड शुरू होने पर इन्वेंटरी लाकर _build/.doctrees/__intersphinx_cache__ में intersphinx_cache_limit दिनों तक रखी जाती है: डिफ़ॉल्ट 5, ऋणात्मक मान पर बनी रहती है। स्थानीय फ़ाइल हर बिल्ड में पढ़ती है। Sphinx की तरह रीडायरेक्ट के बाद नई निर्देशिका लिंक का आधार बनती है और कैश उसे याद रखता है, ताकि कैश से वही लिंक बने। जैसे https://werkzeug.palletsprojects.com/objects.inv का रीडायरेक्ट /en/stable/ पर है। intersphinx_timeout हर डाउनलोड का समय सेकंड में सीमित करता है। न पहुँच सकने वाला प्रोजेक्ट चेतावनी देता है और उसके संदर्भ अनसुलझे रहते हैं।
Guidedog सभी पृष्ठ, लेबल, शब्द और ऑब्जेक्ट सहित अपनी objects.inv लिखता है, जिससे अन्य प्रोजेक्ट भी इसी तरह यहाँ लिंक कर सकते हैं।