पायथन एपीआई

ब्राउज़ करने के वैकल्पिक तरीके क्या यह सिर्फ मुझे है, या अजगर मानक लाइब्रेरी दस्तावेज ब्राउज़ करना बेहद मुश्किल है?पायथन एपीआई

जावा है अपनी शानदार Javadocs, रूबी अपने सहायक एक अच्छा तरीका Ruby-Docs, केवल अजगर में मैं नहीं मिल सकता है मानक पुस्तकालय प्रलेखन के माध्यम से नेविगेट करने के लिए है।

Epydoc प्रोजेक्ट है, जो अच्छा लग रहा है, लेकिन क्या किसी को पता है कि वास्तव में मानक पुस्तकालय पर इसका उपयोग किया जा रहा है, तो क्या हम सभी इसके माध्यम से जा सकते हैं? यदि नहीं, तो पाइथन दस्तावेज ब्राउज़ करने के लिए लोग किस विकल्प का उपयोग कर रहे हैं।

स्रोत

2010-01-25 ivo

पायथन और बड़ी पुस्तकालयों में से कई दस्तावेज के लिए स्फिंक्स का उपयोग करते हैं। प्रयोज्य दृष्टिकोण से उत्पन्न जेनरेट डॉक्स बहुत भयानक हैं (भले ही वे कुछ अच्छे दिखने वाले सीएसएस का उपयोग करें)। इसके लिए एक उदाहरण बेहद लंबे पेज हैं, जो ब्राउज़िंग को बहुत कठिन बनाते हैं। – nikow

वाह ... पायथन सबसे अद्भुत दस्तावेज़ नहीं हो सकता है, लेकिन इसे तुलनात्मक रूप से * javadoc * से तुलना कर रहा है? यह दस्तावेज़ जावा के बारे में मेरी सबसे कम पसंदीदा चीज़ है: आपको आम तौर पर एक छोटा सा सतही ट्यूटोरियल मिलता है और उसके बाद केवल जवाडोक होता है: क्लास का एक बेकार भूलभुलैया और तकनीकी विवरणों को विधिबद्ध तरीके से ढूंढने के लिए कोई निर्देश नहीं है कि सबकुछ कैसे व्यवस्थित किया गया है और आप ' उपयोग करने की उम्मीद है। – bobince

मुझे एपीआई ब्राउज़ करने के लिए javadocs एक बेहतरीन टूल मिल गया है। प्रलेखन की गुणवत्ता उपकरण की ज़िम्मेदारी नहीं है, बल्कि दस्तावेज़ीकरण लेखक की है। तो आईएमएचओ, हां, जावाडॉक्स आधिकारिक पायथन दस्तावेज साइट का उपयोग कर रहे हैं उससे काफी बेहतर हैं। – ivo

मैं आमतौर पर अंतर्निहित pydoc का उपयोग करता हूं, यदि आप विंडोज़ पर हैं तो इसे मॉड्यूल डॉक्स कहा जाना चाहिए यदि आप लिनक्स पर pydoc -p 8000 का उपयोग करते हैं और ब्राउज़र से कनेक्ट करते हैं।

स्रोत

2010-01-25 10:30:29

आप here पर जा सकते हैं और पायथन 3.1 के chm संस्करण को डाउनलोड कर सकते हैं। इसके साथ, दस्तावेज़ों के माध्यम से खोजना आसान होना चाहिए।

स्रोत

2010-01-25 10:02:04 ghostdog74

pydoc कमांड लाइन से help() इंटरैक्टिव दुभाषिया प्रॉम्प्ट से।

स्रोत

2010-01-25 10:32:36

pydoc -p 8080

अजगर समुदाय अर्द्ध शत्रुतापूर्ण स्वचालित रूप से उत्पन्न दस्तावेज़ीकरण के लिए, खासकर अगर यह वस्तु केंद्रित है। पायथन केवल ऑब्जेक्ट-ओरिएंटेड नहीं है (यह एक बहु-प्रतिमानी भाषा है), इसलिए पाइथन डेवलपर्स आम तौर पर मानव-लिखित दस्तावेज पसंद करते हैं। कभी-कभी कार्य महत्वपूर्ण होते हैं, कभी-कभी कक्षा संरचना महत्वपूर्ण होती है।

स्रोत

2010-01-25 10:42:35 wisty

हाँ, मैंने कुछ शत्रुता का स्वाद लिया है ... – ivo

मैं बहुत समय पहले Edgewall से python sidebar का उपयोग करता था।

इन दिनों, मैं अजगर फ़ंक्शन के लिए Google (मानक दस्तावेज़ लगभग हमेशा पहले लिंक के रूप में दिखाई देता हूं)। यदि मैं मॉड्यूल के स्रोत (कभी-कभी उपयोगी) ब्राउज़ करना चाहता हूं, तो मैंने इस छोटे खोल फ़ंक्शन का उपयोग किया है ।

epy() { 
    cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__" 
    file=$(/usr/bin/env python -c $cmd) 
    echo $file 
    emacsclient --no-wait $file 
}

स्रोत

2010-01-25 10:45:31

मुझे लगता है मैं downvoted करने के लिए जा रहा हूँ, लेकिन मैं स्फिंक्स डॉक्स के साथ कुछ भी गलत नहीं लगता है और मैं उन्हें जिस तरह से जिस तरह से जावा विकल्प की तुलना में बेहतर हैं।

स्रोत

2010-01-30 09:14:42

मैं सहमत हूं। स्फिंक्स एक अच्छा उपकरण है और यह अच्छे दस्तावेज़ उत्पन्न करता है। कम से कम पायथन के लिए :) –

पायथन एपीआई

उत्तर

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