मेरी परियोजना CMakeLists.txt फ़ाइलों और स्थानीय प्रोजेक्ट .cmake फ़ाइलों को दस्तावेज़ करने के अच्छे तरीके क्या हैं? दो साल का प्रश्न/उत्तर Documenting CMake scripts है कि मैं अनिवार्य रूप से यहां फिर से पूछ रहा हूं। उत्तर मेंदस्तावेजिंग CMakeLists.txt और कस्टम या स्थानीय .cmake फ़ाइलें
वर्तमान में, सीएमके 3.0 विकास में है जो स्फिंक्स और पुन: संरचित पाठ के आधार पर एक नई प्रलेखन प्रणाली प्राप्त करेगा। मुझे लगता है कि यह आपके मॉड्यूल को दस्तावेज करने के नए तरीके लाएगा।
मैं cmake developer documentation पर ध्यान दिया है, लेकिन इस नई प्रलेखन प्रणाली लगता cmake खुद के दस्तावेजीकरण की दिशा में सक्षम। मैं नहीं देखता कि मैं अपने उपयोगकर्ता द्वारा परिभाषित प्रोजेक्ट CMakeLists.txt फ़ाइलों या स्थानीय .cmake फ़ाइलों को दस्तावेज़ित करने के लिए इसका उपयोग कैसे कर सकता हूं।
मुझे उम्मीद है कि सेमेक परियोजना के आंतरिक रूप से विभिन्न स्फिंक्स निर्देश और भूमिकाएं हैं क्योंकि उपयोगकर्ता के रूप में कुछ ऐसा तरीका था जो मैं स्फिंक्स के इस आंतरिक उपयोग का लाभ उठा सकता हूं। मैं अपने CMakeLists.txt फ़ाइलों और स्थानीय .cmake फ़ाइलों में पहिया को फिर से घुमाने के बिना कुछ मार्कअप प्राप्त करने में सक्षम होना चाहता हूं। अन्य परियोजनाओं में संबंधित प्रयास हैं। उदाहरण के लिए आरओएस कैटकिन प्रोजेक्ट मैंने देखा है कि सबसे पूरा दृष्टिकोण प्रदान करता है, लेकिन गैर-आरओएस परियोजनाओं के लिए उपयोग करना आसान हेवीवेट नहीं है। (उदाहरण के तौर पर, उनके extracted cmake api page देखें।) सबसे सरल, sphinx-contrib cmakedomain है, लेकिन यह मार्कअप टिप्पणियों के साथ autodoc दृष्टिकोण के बजाय एक अलग आरएसटी स्रोत दस्तावेज़ पर निर्भर करता है।
शायद यह सेमेक सूची के लिए एक सवाल है, लेकिन मुझे उम्मीद थी कि कोई स्टैक ओवरव्लो की निगरानी कर रहा था।
मुझे नहीं लगता कि यह सीएमके से संबंधित है, स्पिनिक्स के बारे में है। क्या आपने इसके उपयोग के बारे में एक ट्यूटोरियल पढ़ने की कोशिश की? – Joel
हां, मुझे पता है कि स्फिंक्स का उपयोग कैसे करें। लेकिन मुझे नहीं पता कि मेरे '' CMakeLists.txt'' या अन्य ''cmake'' फ़ाइलों को दस्तावेज़ित करने के लिए cmake 3 * नई दस्तावेज़ प्रणाली * का उपयोग कैसे करें। सेमेक दस्तावेज़ प्रलेखन उपयोगकर्ताओं को उनके प्रोजेक्ट विशिष्ट सेमेक फ़ाइलों को दस्तावेज करने के लिए नहीं, cmake दस्तावेज के लिए प्रतीत होता है। – Phil