स्फिंक्स - पायथन मॉड्यूल, कक्षाएं और फ़ंक्शंस प्रलेखन

Question

मैं अपनी छोटी परियोजना को स्फिंक्स के माध्यम से दस्तावेज करने की कोशिश कर रहा हूं जो हाल ही में परिचित होने की कोशिश कर रहा हूं। मैंने कुछ ट्यूटोरियल और स्फिंक्स दस्तावेज पढ़ा लेकिन इसे नहीं बनाया जा सका। सेटअप और विन्यास ठीक है! तकनीकी तरीके से स्फिंक्स का उपयोग करने में केवल समस्याएं हैं।

सामग्री की मेरी मेज इस

--- Overview 

    .....Contents 

----Configuration 

     ....Contents 

---- System Requirements 

     .....Contents 

---- How to use 

     .....Contents 

---- Modules 

     ..... Index 

     ......Display 


----Help 

     ......Content 

की तरह दिखना चाहिए इसके अलावा मेरी फोकस docstrings साथ पर मॉड्यूल है। मॉड्यूल का विवरण हैं

निर्देशिका: - सी:/WAMP/www/परियोजना/

  ----- Index.py 

         >> Class HtmlTemplate: 

           .... def header(): 

           .... def body(): 

           .... def form(): 

           .... def header(): 

           .... __init_main: ##inline function 

      ----- display.py 

         >> Class MainDisplay: 

           .... def execute(): 

           .... def display(): 

           .... def tree(): 

           .... __init_main: ##inline function 

मेरे प्रलेखन निर्देशिका: - सी:/उपयोगकर्ताओं/abc/डेस्कटॉप/प्रलेखन/doc/

      --- _build 

          --- _static 

          --- _templates 

          --- conf.py 

          --- index.rst 

मैंने सिस्टम वातावरण में मॉड्यूल निर्देशिका जोड़ दी है और index.rst संपादित की गई सामग्री के परीक्षण के लिए निम्नलिखित कोड के साथ संपादित किया है। लेकिन मैं इसके अलावा सीधे

Index.rst>>>>>>> 


T-Alignment Documentation 
************************* 

.. _overview: 

Overview 
-------- 

.. _System Requirement: 

System Requirement 
------------------ 

1. System 

2. Applications 

3. Server 

.. _Configuration:: 

Configuration 
------------- 

Basic steps in configuration involves in following categories 

1. Environment variables 

2. Apache setting 

.. _Modules:: 

Modules 
------- 

मैं कैसे यहां से जारी रख सकते हैं docstring को अलग नहीं कर सकता है ...

, मैं सिर्फ अभी शुरुआत कर रहा हूँ प्रलेखन उपकरण स्फिंक्स को

मैं करने के लिए अपने सुझाव की जरूरत है मेरी मॉड्यूल

धन्यवाद

Answer 1

अपने मॉड्यूल के उपयोग करने के लिए मेरी दस्तावेज़ीकरण पृष्ठ पर docstring लाता है डॉकस्ट्रिंग्स को आपको autodoc extension का उपयोग करना होगा। इसे सक्षम करने के लिए अपने conf.py में "extension" variable का उपयोग करें।

Answer 2

फ्लोरियन बिल्कुल सही है; "ऑटोडोक एक्सटेंशन", जिसका लिंक वह प्रदान करता है, वह है जिसे आप ढूंढ रहे हैं। यदि आपको स्फिंक्स के बारे में अधिक जानकारी की आवश्यकता है, तो आपको PyCon 2010 में दिए गए ट्यूटोरियल मिल सकते हैं - हालांकि आपको संदेह होगा कि यह बहुत लंबा लगेगा। :-)

http://pycon.blip.tv/file/3359587/