Guidedog मैनुअल 0.2.0
भाषा
इस पृष्ठ पर
Guidedog / दस्तावेज़ 0.2.0

कॉन्फ़िगरेशन संदर्भ

हर Guidedog परियोजना की सेटिंग मुख्य फ़ोल्डर की conf.toml में रहती है। Guidedog इसे घोषणात्मक TOML डेटा की तरह पढ़ता है; मनमाना कोड नहीं चलाता।

कई सेटिंग कुंजियाँ Sphinx की conf.py के चर से मेल खाती हैं, इसलिए guidedog migrate conf.py से माइग्रेशन किया जा सकता है।

न्यूनतम कॉन्फ़िगरेशन

परियोजना के लिए मूल जानकारी ही काफ़ी है। छोड़ी गई सेटिंग के लिए डिफ़ॉल्ट मान लागू होते हैं:

project = "Field Notes"
author = "Your Name"
version = "1.0"
release = "1.0.0"
language = "en"
root_doc = "index"
source_suffix = [".rst", ".md"]
templates_path = ["_templates"]
html_static_path = ["_static"]
pdf_paper_size = "a4"

परियोजना का मेटाडेटा

तालिका 8 मेटाडेटा के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
project स्ट्रिंग "Python" पाठक को दिखाया जाने वाला परियोजना का नाम।
author स्ट्रिंग "" लेखक या संगठन का नाम।
copyright स्ट्रिंग "" पृष्ठ के नीचे दिखाया जाने वाला कॉपीराइट विवरण।
version स्ट्रिंग "" छोटा संस्करण नंबर, जैसे "1.0"।
release स्ट्रिंग "" पूरा संस्करण नंबर, जिसमें alpha या beta पहचान भी हो सकती है, जैसे "1.0.0b1"।
language स्ट्रिंग "en" टाइपसेटिंग, शब्द-विभाजन और अनुवाद के लिए ISO भाषा कोड, जैसे "de" या "zh_CN"।
today स्ट्रिंग "" अपनी तारीख़ का पाठ। इसे छोड़ने पर वर्तमान तारीख़ today_fmt से स्वरूपित होती है।
today_fmt स्ट्रिंग "" दस्तावेज़ की तारीख़ के लिए फ़ॉर्मैट स्ट्रिंग।

सामान्य विकल्प

तालिका 9 खोज और पार्सिंग के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
root_doc स्ट्रिंग "index" विषय-सूची का मूल दस्तावेज़।
source_suffix ऐरे [".rst"] दस्तावेज़ स्रोत के रूप में पहचाने जाने वाले एक्सटेंशन।
exclude_patterns ऐरे [] स्रोत खोज में छोड़ने वाले फ़ोल्डर और फ़ाइलों के glob पैटर्न।
include_roots ऐरे [] स्रोत शामिल करने के लिए अनुमत बाहरी मूल फ़ोल्डर।
templates_path ऐरे [] HTML और PDF टेम्पलेट के फ़ोल्डर; अंतर्निहित टेम्पलेट से पहले खोजे जाते हैं।
extensions ऐरे [] सक्रिय करने वाले समर्थित अंतर्निहित Sphinx एक्सटेंशन, जैसे "sphinx.ext.autodoc"।
primary_domain स्ट्रिंग "py" बिना उपसर्ग के निर्देश और रोल का डिफ़ॉल्ट डोमेन, जैसे "py", "c" या "odin"।
highlight_language स्ट्रिंग "default" कोड ब्लॉक में भाषा न लिखने पर इस्तेमाल होने वाली भाषा।
pygments_style स्ट्रिंग "" हल्की थीम के लिए Pygments हाइलाइटिंग स्टाइल।
pygments_dark_style स्ट्रिंग "" गहरी थीम के लिए सिंटैक्स हाइलाइटिंग स्टाइल।
smartquotes बूलियन true सीधे उद्धरण चिह्न और डैश को टाइपोग्राफ़िक चिह्नों में बदलता है।
rst_prolog स्ट्रिंग "" हर दस्तावेज़ के शुरू में जोड़ा जाने वाला reStructuredText अंश।
rst_epilog स्ट्रिंग "" हर दस्तावेज़ के अंत में जोड़ा जाने वाला reStructuredText अंश।

क्रमांक और गणित

तालिका 10 क्रमांक के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
numfig बूलियन false सक्रिय करने पर चित्र, तालिका और कोड को अपने आप क्रमांक देता है।
numfig_secnum_depth पूर्णांक 1 चित्र के क्रमांक में शीर्षक की गहराई; जैसे 1 से Fig. 2.1 बनता है।
numfig_format टेबल नीचे देखें "figure", "table" और "code-block" के क्रमांक उपसर्ग का प्रारूप।
math_number_all बूलियन false हर अलग पंक्ति वाले समीकरण को अपने आप क्रमांक देता है।
math_eqref_format स्ट्रिंग "({number})" :eq: से दिए गए समीकरण संदर्भ का फ़ॉर्मैट।
mathjax_path स्ट्रिंग URL MathJax JavaScript फ़ाइल का CDN पता या स्थानीय पथ।

numfig_format के डिफ़ॉल्ट मान:

[numfig_format]
figure = "Fig. %s"
table = "Table %s"
code-block = "Listing %s"
section = "Section %s"

निदान और सख़्त जाँच

तालिका 11 निदान के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
nitpicky बूलियन false अनसुलझे पार-संदर्भ और टूटे लक्ष्य पर चेतावनी देता है।
nitpick_ignore ऐरे [] सख़्त संदर्भ जाँच से छूट पाने वाले [type, target] जोड़ों की सूची।
suppress_warnings ऐरे [] न दिखाए जाने वाले चेतावनी वर्गों के कोड।
keep_warnings बूलियन false प्रकाशित दस्तावेज़ में चेतावनियाँ शामिल करता है।

HTML आउटपुट के विकल्प

तालिका 12 HTML के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
html_theme स्ट्रिंग "guidedog" HTML बनाने के लिए इस्तेमाल होने वाली थीम।
html_theme_options टेबल {} HTML थीम को दिए जाने वाले कुंजी-मान विकल्प।
html_title स्ट्रिंग अपने आप तय होता है ब्राउज़र टैब में दिखने वाला शीर्षक।
html_short_title स्ट्रिंग अपने आप तय होता है नेविगेशन पथ में दिखने वाला छोटा शीर्षक।
html_logo स्ट्रिंग "" स्रोत फ़ोल्डर के सापेक्ष परियोजना के लोगो का पथ।
html_favicon स्ट्रिंग "" फ़ेविकॉन फ़ाइल का पथ।
html_static_path ऐरे [] आउटपुट के _static/ में कॉपी किए जाने वाले फ़ोल्डर।
html_extra_path ऐरे [] बिना बदलाव आउटपुट के मूल फ़ोल्डर में कॉपी किए जाने वाले फ़ोल्डर।
html_css_files ऐरे [] HTML पृष्ठों में लोड की जाने वाली अपनी CSS फ़ाइलों के नाम।
html_js_files ऐरे [] HTML पृष्ठों में लोड की जाने वाली अपनी JavaScript फ़ाइलों के नाम।
html_permalinks बूलियन true अनुच्छेद और खंडों के लिए स्थायी लिंक जोड़ता है।
html_permalinks_icon स्ट्रिंग "¶" स्थायी लिंक के लिए इस्तेमाल होने वाला चिह्न या पाठ।
html_baseurl स्ट्रिंग "" साइटमैप और मेटाडेटा के लिए मानक आधार URL।
html_context टेबल {} Jinja टेम्पलेट को दिए जाने वाले अपने चर का शब्दकोश।
html_additional_pages टेबल {} बनाए जाने वाले अतिरिक्त पृष्ठ: { "page_name" = "template.html" }।

PDF और Typst के विकल्प

तालिका 13 PDF के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
pdf_paper_size स्ट्रिंग "a4" कागज़ का आकार: "a4" या "us-letter"।
pdf_logo स्ट्रिंग "" पुस्तक के आवरण पर लगाने वाले लोगो का पथ।
pdf_toplevel_sectioning स्ट्रिंग "chapter" पुस्तक के मुख्य विभाजन का स्तर: "chapter" या "part"।
pdf_show_urls स्ट्रिंग "no" मुद्रित पाठ में URL दिखाने की नीति: "no", "inline" या "footnote"।
pdf_preamble स्ट्रिंग "" बने दस्तावेज़ की शुरुआत में जोड़ा जाने वाला रॉ Typst स्रोत।
pdf_font_paths ऐरे [] अपने OTF/TTF फ़ॉन्ट खोजने के अतिरिक्त फ़ोल्डर।
pdf_packages स्ट्रिंग "download" पैकेज खोजने की नीति: "download" या "offline"।
typst स्ट्रिंग "typst" सिस्टम के Typst CLI का नाम या पूरा पथ।

PDF पुस्तक तय करना

[[pdf_documents]] टेबल में परियोजना से बनने वाली एक या अधिक पुस्तकें तय की जाती हैं:

[[pdf_documents]]
root = "index"
file = "guide.pdf"
title = "Field Notes Complete Guide"
author = "Author Name"

[[pdf_documents]]
root = "reference/index"
file = "reference.pdf"
title = "Field Notes Reference"
author = "Author Name"

MyST Markdown के विकल्प

तालिका 14 MyST Markdown के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
myst_enable_extensions ऐरे ["dollarmath"] सिंटैक्स एक्सटेंशन: "colon_fence", "deflist", "dollarmath", "fieldlist", "tasklist", "substitution"।
myst_heading_anchors पूर्णांक 0 शीर्षक से एंकर बनाने की गहराई; 0 से यह बंद होता है।
myst_substitutions टेबल {} Markdown में उपलब्ध चर के प्रतिस्थापन: {key = "value"}।
myst_url_schemes ऐरे ["http", ...] बाहरी लिंक माने जाने वाले URI स्कीम।
myst_commonmark_only बूलियन false MyST एक्सटेंशन के बिना केवल CommonMark सिंटैक्स पार्स करता है।

Intersphinx के विकल्प

extensions = ["sphinx.ext.intersphinx"]
intersphinx_cache_limit = 5
intersphinx_timeout = 30

[intersphinx_mapping]
python = ["https://docs.python.org/3/", ""]
click = ["https://click.palletsprojects.com/", ["click.inv", ""]]

पूरी प्रक्रिया के लिए अन्य परियोजनाओं से लिंक देखें।

Python autodoc के विकल्प

तालिका 15 Autodoc के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
autodoc_source_paths ऐरे [] स्थिर विश्लेषण में Python मॉड्यूल खोजने के फ़ोल्डर।
autoclass_content स्ट्रिंग "class" क्लास के docstring का स्रोत: "class", "init" या "both"।
autodoc_member_order स्ट्रिंग "alphabetical" सदस्यों का क्रम: "alphabetical", "bysource" या "groupwise"।
autodoc_typehints स्ट्रिंग "signature" टाइप संकेत दिखाने की जगह: "signature", "description" या "none"।
autodoc_default_options टेबल {} सभी auto* निर्देशों पर लागू डिफ़ॉल्ट विकल्प।

खोज के पूरे नियमों के लिए autodoc से Python का दस्तावेज़ीकरण देखें।

Odin API दस्तावेज़ के विकल्प

तालिका 16 Odin डोमेन के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
odin_autoapi_dirs ऐरे [] Odin पैकेज खोजने के स्रोत फ़ोल्डर।
odin_autoapi_root स्ट्रिंग "api" बने Odin API दस्तावेज़ों का आउटपुट उपफ़ोल्डर।
odin_autoapi_options ऐरे ["members", "undoc-members"] शामिल किए जाने वाले सदस्यों का फ़िल्टर।
odin_autoapi_member_order स्ट्रिंग "source" सदस्यों का क्रम: "source" या "alphabetical"।

Odin डोमेन के पूरे उपयोग के लिए Odin के दस्तावेज़ बनाना देखें।

अंतर्राष्ट्रीयकरण के विकल्प

तालिका 17 i18n के विकल्प
कुंजी प्रकार डिफ़ॉल्ट विवरण
locale_dirs ऐरे ["locales"] gettext अनुवाद कैटलॉग खोजने के फ़ोल्डर।
gettext_compact बूलियन true एक फ़ोल्डर के दस्तावेज़ों के संदेश एक कैटलॉग में जोड़ता है।
gettext_uuid बूलियन false POT संदेशों में स्थिर UUID लिखता है।
gettext_auto_build बूलियन true बिल्ड के दौरान .po को बाइनरी .mo कैटलॉग में बदलता है।
figure_language_filename स्ट्रिंग "{root}.{language}{ext}" भाषा के अनुसार चित्र चुनने के लिए फ़ाइल नाम का टेम्पलेट।

अनुवाद के निर्देशों के लिए अंतरराष्ट्रीयकरण देखें।