ऑब्जेक्ट टाइप घोषित करना¶
परियोजना को ऐसे नाम चाहिए हो सकते हैं जिन्हें मानक डोमेन नहीं जानते। TOML में उनके ऑब्जेक्ट टाइप घोषित करें। Guidedog Python एक्सटेंशन लोड किए बिना लक्ष्य, इंडेक्स प्रविष्टि और रोल बना सकता है। घोषणा सिंटैक्स बताती है, चलने वाला व्यवहार नहीं।
लक्ष्य: add_crossref_type¶
[[crossref_types]]
directive = "setting"
role = "setting"
index = "pair: %s; setting"
तब .. setting:: DEBUG setting-DEBUG ID वाला लक्ष्य और इंडेक्स प्रविष्टि बनाता है। :setting:`DEBUG` उसे लिंक करता है, Sphinx की तरह। index Sphinx का indextemplate है: पहले कोलन से पहले प्रकार (single, pair, triple, see, seealso), बाद में प्रविष्टि, और %s नाम है।
विवरण: add_object_type¶
[[object_types]]
directive = "django-admin"
role = "djadmin"
index = "pair: %s; django-admin command"
name = "first-word"
display = "django-admin %s"
program = true
.. django-admin:: migrate [app_label] कमांड को ऑब्जेक्ट की तरह सिग्नेचर, सामग्री, ID (django-admin-migrate) और इंडेक्स प्रविष्टि के साथ बताता है। Sphinx में parse_node फ़ंक्शन सिग्नेचर पढ़ सकता है; उसका सामान्य काम यहाँ फ़ील्ड से तय होता है:
name-
"whole"(डिफ़ॉल्ट): पूरा सिग्नेचर ऑब्जेक्ट का नाम है।"first-word": पहले खाली स्थान तक का भाग नाम है। जैसेpdbकाb(reak) [lineno]नामb(reak)रखता है। display-
सिग्नेचर कैसे दिखे;
%sउसका स्थान लेता है। डिफ़ॉल्ट में लिखा हुआ रूप। program-
true: नाम आगे बताए विकल्पों का प्रोग्राम बनता है, जैसा.. program::करता है।
निर्देश के अन्य नाम¶
एक्सटेंशन Sphinx के निर्देश को दूसरे नाम से पंजीकृत कर सकता है:
[directive_aliases]
django-admin-option = "option"
awaitablefunction = "py:function"
डोमेन के बिना लक्ष्य मानक या डिफ़ॉल्ट डोमेन का निर्देश है। py:function जैसा लक्ष्य अपना डोमेन बताता है।
माइग्रेशन¶
guidedog migrate conf.py में सूचीबद्ध परियोजना के एक्सटेंशन मॉड्यूल ढूँढता है। उनके add_crossref_type, add_object_type और add_directive कॉल पढ़कर, बिना चलाए, ये तालिकाएँ लिखता है। जो घोषित नहीं कर सकता वह बताता है: parse_node फ़ंक्शन (name, display, program से मिलाएँ), और Python के निर्देश, रोल तथा इवेंट हैंडलर।