2011-09-11 17 views
5

पर दस्तावेज़ उत्पन्न करने के लिए PyDoc को कैसे बताना है Pydoc मॉड्यूल के दस्तावेज़ उत्पन्न करते समय वर्तमान निर्देशिका में HTML दस्तावेज़ बनाता है। मुझे वास्तव में एक और निर्देशिका निर्दिष्ट करने की आवश्यकता है जो जेनरेटेड प्रलेखन के लिए प्लेसहोल्डर होगा जिसके बजाय पीईडीओक कहा जाता है।उपयोगकर्ता परिभाषित निर्देशिका

मैं प्रलेखन उत्पन्न करने के लिए python -m pydoc -w <MODULES_DIR> का उपयोग कर रहा हूं।

क्या यह संभव है और यदि यह है, तो कैसे?

उत्तर

3

pydoc डब्ल्यू ...

वर्तमान निर्देशिका में फाइल करने के लिए एक मॉड्यूल के लिए HTML प्रलेखन बाहर लिखें। यदि कोई '/' है, तो इसे फ़ाइल नाम के रूप में माना जाता है; यदि यह एक निर्देशिका नाम है, दस्तावेज़ीकरण सभी सामग्री के लिए लिखा गया है।

+0

क्षमा करें, वाक्यविन्यास में मेरी गलती। मैं python -m pydoc -w का उपयोग कर रहा हूं लेकिन जेनरेट किया गया दस्तावेज़ वर्तमान निर्देशिका में जाता है जैसा मैंने वर्णन किया है। लेकिन मैं चाहता हूं कि यह दस्तावेज़ किसी अन्य निर्देशिका में सहेजा जाए। मुझे PyDoc पर किसी अन्य स्विच के बारे में पता नहीं है जो मैं चाहता हूं कि प्रभाव उत्पन्न करेगा। –

+0

क्या आपके द्वारा निर्दिष्ट निर्देशिका मौजूद है? क्या आप निर्देशिका नाम के अंत में/जोड़ते हैं? –

3

मुझे एक ही समस्या थी और इसे समझने की कोशिश कर इस प्रश्न में आया। मैं यह नहीं समझ सका कि यह कैसे करना है, इसलिए यह मेरा समाधान है। किसी विशिष्ट स्थान पर आउटपुट करने के लिए पाइडोक को ट्रिक करने का प्रयास करने के बजाय, मैं केवल वर्तमान निर्देशिका में प्रलेखन उत्पन्न कर रहा हूं और फ़ाइलों को उस स्थान पर ले जा रहा हूं जहां मैं चाहता हूं।

मेरे मामले में, लक्ष्य फ़ोल्डर 'दस्तावेज़' नाम दिया गया है, और स्रोत 'semlm' निर्देशिका के अंतर्गत स्थित है

mkdir -p doc 
pydoc -w `find semlm -name '*.py'` 
mv *.html doc 

(आप pydoc आदेश अनुकूलित करने के लिए अपनी इच्छानुसार में सक्षम होना चाहिए, लेकिन इसी से मेरा काम बना है)।

मैं इसे हर बार टाइप नहीं करना चाहता था इसलिए मैंने इसे मेकफ़ाइल में रखा। यहाँ एक अंश है:

.PHONY: doc 

doc: 
    mkdir -p doc 
    pydoc -w `find semlm -name '*.py'` 
    mv *.html doc 

क्योंकि Makefile लक्ष्य शीर्ष स्तर की निर्देशिका (जैसे 'दस्तावेज़') में एक फ़ोल्डर के रूप में एक ही नाम है .PHONY: doc की जरूरत है। अब मैं चलाकर दस्तावेज़ फ़ोल्डर में प्रलेखन उत्पन्न कर सकते हैं:

make doc 

शायद वहाँ एक और अधिक सुरुचिपूर्ण तरीका है, लेकिन यह सबसे अच्छा मैं अब तक मिल गया है है।

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