मेरे जावास्क्रिप्ट ढांचे के लिए मैं स्फिंक्स का उपयोग करना चाहता हूं। चूंकि मैं स्फिंक्स दुनिया में नया हूं, इसलिए मैं आपको लोगों को स्फिंक्स और जावास्क्रिप्ट से शुरू करने में मदद करने के लिए चाहता हूं।स्फिंक्स और जावास्क्रिप्ट दस्तावेज़ीकरण वर्कफ़्लो
किसी भी मदद की सराहना की।
बेस्ट सादर
मैं तुम्हें स्फिंक्स के लिए 'JavaScript Domain सुविधा देख रहे हैं विश्वास करते हैं।
संपादित करें: प्रलेखन & उपकरण पर त्वरित गति से, ऐसा लगता है कि आप अपनी जावास्क्रिप्ट के अंदर रीस्ट का उपयोग कर सकते हैं। आपको या तो टिप्पणियों से दस्तावेज़ों को बाहर निकालना होगा, या साइडकार-फाइलों में इसे चारों ओर रखना होगा।
बहुत देर हो चुकी प्रतिक्रिया के लिए खेद है)
आप की तरह मैं AngularJS के आधार पर अपने खुद के जे एस ढांचे के लिए डॉक्स का निर्माण करना चाहते हैं।
और तरह oliverseal, मैं स्फिंक्स और ext.autodoc के लिए देशी रास्ते में स्फिंक्स विस्तार बनाया हूँ sphinxcontrib-autoanysrc
यह सरल और साफ है, लेकिन ऑटो पीढ़ी हस्ताक्षर और दूसरों के लिए ext.autodoc सुविधाओं है, लेकिन यह पर्याप्त के लिए मुझे autoanysrc.JSAnalyzer
की जाँच js फ़ाइलों में ढांचे एपीआई)
आप sphinxcontrib-autoanysrc विस्तार के साथ ext.autodoc सुविधाओं को लागू कर सकते हैं के बाकी डॉक्स की दुकान मैं इस डोमेन सुविधा को देखा है, लेकिन नहीं जानते कि कैसे मैं शुरू करूं उस। –
ठीक है, मैं अपनी जावास्क्रिप्ट लाइब्रेरी के अंदर रीस्ट का उपयोग नहीं करना चाहता, यह अच्छा होगा अगर सभी लाइब्रेरी सदस्यों को स्वचालित रूप से स्फिंक्स द्वारा संबंधित टिप्पणियों के साथ पता चला हो। –
मैं काफी पालन नहीं करता; »Sphinx द्वारा ऑटो-डिटेक्ट लाइब्रेरी« सदस्यों और »संबंधित टिप्पणियां«? AFAIK, स्फिंक्स को पता नहीं है कि जावास्क्रिप्ट-कोड को कैसे पढ़ा जाए, इसलिए यह न तो आपके लिए फ़ंक्शंस या उनके संबंधित दस्तावेज़ों को पार्स कर सकता है। यही कारण है कि मैंने साइडकार फाइलों के उपयोग का सुझाव दिया। –