python-sphinx ट्यूटोरियल
अजगर-स्फिंक्स के साथ शुरुआत करना

टिप्पणियों

स्थापना या सेटअप

चूंकि स्फिंक्स पायथन पैकेज इंडेक्स पर उपलब्ध है, इसलिए इसे पाइप का उपयोग करके स्थापित किया जा सकता है:

pip install Sphinx

या आप easy_install का उपयोग करके भी स्थापित कर सकते हैं

easy_install -U sphinx

फिर आप जांच सकते हैं कि यह निम्नलिखित कमांड को निष्पादित करके सही तरीके से स्थापित किया गया है:

> sphinx-quickstart --version
Sphinx v1.4.1

आगे बढ़ने से पहले आपको अजगर पीईपी 8 के लिए कुछ कोड शैली का पालन करने की आवश्यकता है। यदि आपने PEP 8 दिशानिर्देश का पालन किया है, तो आप स्फिंक्स में दस्तावेज़ संरचना को परिभाषित कर सकते हैं और अपने दस्तावेज़ बनाना शुरू कर सकते हैं ।

जल्दी शुरू

आरंभ करने के लिए परियोजना निर्देशिका के मूल में जाएं और चलाएं:

$ sphinx-quickstart

आपको अपनी परियोजना के लिए दस्तावेज़ बनाने के विकल्प मिलेंगे। डिफ़ॉल्ट सेटअप के लिए नीचे दिए गए आदेशों का पालन करें:

Prompt    Choice
> Root path for the documentation [.]:    <ENTER>
> Separate source and build directories (y/N) [n]:    y
> Name prefix for templates and static dir [_]:    <ENTER>
> Project name:    an_example_pypi_project
> Author name(s):    Andrew Carter
> Project version:    0.0.1
> Project release [0.0.1]:    <ENTER>
> Source file suffix [.rst]:    <ENTER>
> Name of your master document (without suffix) [index]:    <ENTER>
> autodoc: automatically insert docstrings from modules (y/N) [n]:    y
> doctest: automatically test code snippets in doctest blocks (y/N) [n]:    n
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]:    y
> todo: write “todo” entries that can be shown or hidden on build (y/N) [n]:    n
> coverage: checks for documentation coverage (y/N) [n]:    n
> pngmath: include math, rendered as PNG images (y/N) [n]:    n
> jsmath: include math, rendered in the browser by JSMath (y/N) [n]:    n
> ifconfig: conditional inclusion of content based on config values (y/N) [n]:    y
> Create Makefile? (Y/n) [y]:    n
> Create Windows command file? (Y/n) [y]:    n

सफल निष्पादन पर आप अपने प्रोजेक्ट के doc / स्रोत निर्देशिका में config.py फ़ाइल खोज सकते हैं। इस फ़ाइल की मूल संरचना पर नियंत्रण है कि जब आप नीचे दिए गए कमांड बनाते हैं तो आपका दस्तावेज़ कैसे उत्पन्न होगा

$ sphinx-build -b html sourcedir builddir

विस्तृत निर्देश यहां दिए जा सकते हैं: https://pythonhosted.org/an_example_pypi_project/shanin.net.html