2011-06-13 14 views
5

के लिए प्रलेखन ऑटो उत्पन्न करने के लिए admindocs उपयोग thre django.contrib.admindocs पैकेज का उपयोग करने के .py फ़ाइलोंDjango - स्वयं के कोड

उत्तर

4

संभव seporate में अपने मॉडल और विचारों और कार्यों मैं के लिए HTML/पीडीएफ प्रलेखन उत्पन्न करने के लिए एक रास्ता है - - कैसे आपकी फ़ाइलों के लिए डॉक्स

संरचित कर रहे पर निर्भर करता है आप बस अपने अजगर फाइलों से उपयोगकर्ता के अनुकूल डॉक्स उत्पन्न करने के लिए आप HTML पैदा करने के लिए अजगर स्फिंक्स http://sphinx.pocoo.org/

काफी मानक के साथ बंद बेहतर हो सकता है देख रहे हैं दस्तावेज - एक ही प्रणाली हमें ReadTheDocs

+0

पर फिर आप संकलित स्पिंक्स एचटीएमएल दस्तावेज़ों को django व्यवस्थापक से जोड़ सकते हैं ताकि केवल कर्मचारी उपयोगकर्ता उन्हें देख सकें? – littlepea

+1

दो तरीकों से, पहले मुझे लगता है कि स्फिंक्स दस्तावेज़ों को एक टेम्पलेट फ़ोल्डर में कॉपी करना है और एक कस्टम यूआरएल/व्यू बनाना है जो उस निर्देशिका को केवल कर्मचारियों के लिए प्रतिबंधों के साथ मानचित्र करता है - फिर व्यवस्थापक टेम्पलेट में उस अनुभाग में एक लिंक जोड़ें - शायद इसे पूरा करने के लिए और अधिक सुरुचिपूर्ण तरीके लेकिन एक प्रारंभिक बिंदु – Alvin

+1

धन्यवाद एल्विन! असल में मैंने इस उद्देश्य के लिए एक पुन: प्रयोज्य ऐप बनाया है: [django-docs] (http://django-docs.readthedocs.org/en/latest/);) – littlepea

संबंधित मुद्दे