CentOS 7 पर कई प्रारूपों में दस्तावेज़ बनाने के लिए स्फिंक्स का उपयोग करें

• आवश्यक शर्तें
• चरण 1: सिस्टम को अपडेट करें
• चरण 2: पाइप और स्फिंक्स स्थापित करें
• चरण 3: अपने दस्तावेज़ के लिए मूल कॉन्फ़िगरेशन सेट करें
• चरण 4: अपने प्रलेखन के लिए पदानुक्रम का निर्माण करें
• चरण 5: ऊपर निर्दिष्ट स्रोत फ़ाइलें बनाएँ
• चरण 6: अपने प्रलेखन का HTML संस्करण आउटपुट करें

स्फिंक्स तकनीशियनों और लेखकों के लिए एक उपयोगी पायथन-आधारित उपकरण है जो उन्हें आसानी से विभिन्न स्वरूपों में सुरुचिपूर्ण, पूर्ण-कार्यात्मक प्रलेखन बनाने की अनुमति देता है। स्फिंक्स के साथ, आप reStructuredText का उपयोग करके दस्तावेज़ लिखते हैं - एक हल्के मार्कअप भाषा - शुरुआत के लिए, फिर आप HTML, LaTeX, PDF, ePub, और अन्य सहित कई प्रारूपों में आउटपुट प्राप्त कर सकते हैं।

इस ट्यूटोरियल में, हम SphinxVult के प्लेटफ़ॉर्म पर एक CentOS 7 x64 उदाहरण को स्थापित करने और उपयोग करने की प्रक्रिया को कवर करेंगे ।

आवश्यक शर्तें

• एक CentOS 7 x64 उदाहरण।
• एक sudo यूजर ।

चरण 1: सिस्टम को अपडेट करें

sudo yum update
sudo shutdown -r now

चरण 2: पाइप और स्फिंक्स स्थापित करें

sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx

चरण 3: अपने दस्तावेज़ के लिए मूल कॉन्फ़िगरेशन सेट करें

उपयोग करना शुरू करने से पहले Sphinx, आपको अपनी स्रोत निर्देशिका निर्दिष्ट करने की आवश्यकता है जिसमें Sphinxआपके सभी दस्तावेज़ चलेंगे और सहेजेंगे। एक बार जब आप उस निर्देशिका को बना लेते हैं sphinx-quickstartजिसे आप उपयोग करने का इरादा रखते हैं, तो आप तब चला सकते हैं जो Sphinxआवश्यक बुनियादी कॉन्फ़िगरेशन को आरंभ और बनाएगा।

sphinx-quickstart एक सेटअप विज़ार्ड के समान है जो आपको उन प्रश्नों से संकेत देगा जो आपके प्रोजेक्ट के पहलुओं को निर्धारित करते हैं।

cd ~
mkdir doc1
cd doc1
sphinx-quickstart

चरण 4: अपने प्रलेखन के लिए पदानुक्रम का निर्माण करें

डिफ़ॉल्ट रूप से, sphinx-quickstartविज़ार्ड कई निर्देशिकाओं और फ़ाइलों को बनाएगा।

_build           # The directory for containing Sphinx output
conf.py          # The file containing your project configurations
index.rst        # The master file containing the hierarchy of your documentation
make.bat         # A Windows command file
Makefile         # A file necessary for running the make command
_static          # The directory for static files, including custom stylesheets, pictures, etc.
_templates       # The directory for custom templates

चलो मास्टर फ़ाइल पर एक नज़र डालें index.rst, जिसमें आपके दस्तावेज़ का पदानुक्रम शामिल है; अर्थात्, सामग्री पेड़ या की तालिका toctree।

इसे टेक्स्ट एडिटर से खोलें:

vi index.rst

जैसा कि आप फ़ाइल की समीक्षा करते हैं, आपको एक अनुभाग कहा जाएगा toctree। यदि आपके पास *.rstआपके दस्तावेज़ के लिए अन्य स्रोत फ़ाइलें ( ) हैं, तो आपको उन्हें toctreeअनुभाग में निर्दिष्ट करना होगा : .. toctree ::: maxdepet: 2

   introduction
   chapter1
   chapter2
   chapter3
   more

यह जरूरी है:

• अपने इनपुट के ऊपर एक रिक्त पंक्ति छोड़ दें।
• अपने स्रोत फ़ाइलों के साथ प्रत्यय न लगाएं .rst।
• अपने स्रोत फ़ाइलों को उनके संबंधित क्रम में रखें।
• प्रति पंक्ति केवल एक फ़ाइल नाम का उपयोग करें।
• के साथ अपनी फ़ाइल नामों को इंगित करें :maxdepth: 2।

एक बार जब आप अपने संशोधनों को पूरा कर लेते हैं, तो अपनी फ़ाइल को सहेजें और टेक्स्ट एडिटर से बाहर निकलें।

ESC
:!wq

चरण 5: ऊपर निर्दिष्ट स्रोत फ़ाइलें बनाएँ

स्रोत फ़ाइलों को उन नामों से बनाया जाना चाहिए जो पहले निर्दिष्ट किए गए थे index.rst, जो मेल खाते हैं , अन्यथा वे अंतिम आउटपुट में शामिल नहीं होंगे।

स्रोत फ़ाइलों के सभी के साथ संगत होना चाहिए reStructuredText markup language। अधिक जानकारी के लिए, कृपया देखें ReStructuredText प्राइमर ।

चरण 6: अपने प्रलेखन का HTML संस्करण आउटपुट करें

एक बार जब आप अपना दस्तावेज़ बनाना समाप्त कर लेते हैं, तो आप HTML format नीचे दिए गए आदेश को निष्पादित करके अपने काम का उत्पादन कर सकते हैं :

make html

आउटपुट को डायरेक्टरी में सहेजा जाएगा ./\_build/htmlजिसमें वेब ब्राउजिंग में फाइल को देखने के लिए जरूरी सभी चीजें शामिल हैं।

यह हमारे ट्यूटोरियल का समापन करता है।