sphinxcontrib-কফি স্পিংক্স autodoc সমর্থন সঙ্গে একটি CoffeeScript ডোমেইন যোগ করে একটি স্পিংক্স এক্সটেনশন.
এই `` .coffee`` ফাইল থেকে উৎস মন্তব্য নিষ্কাশন coffeedoc_ উপর নির্ভর করে. বিশ্বব্যাপী coffeedoc ইনস্টল করার জন্য ::
& Nbsp; NPM -G coffeedoc ইনস্টল
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
ব্যবহারের
প্রথম আপনি conf.py এক্সটেনশন আপনার তালিকায় এক্সটেনশন যোগ করতে হবে:
& Nbsp; এক্সটেনশন = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
পাইথন আপনার উৎস যেখানে সম্পর্কে কোন খেই আছে, আপনি যেখানে আপনার মত conf.py সন্ধান করার জন্য এটা বলতে হবে:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
আপনার প্রকল্পের প্রাথমিকভাবে CoffeeScript হয় অবশেষে, যদি, আপনি ভাল হিসাবে প্রাথমিক ডোমেইন সংজ্ঞায়িত করতে পারেন:
& Nbsp; primary_domain = 'কফি'
ডিরেক্টিভ এবং ভূমিকা
এই ডোমেইন ক্রস উল্লেখ জন্য মডিউল, ফাংশন, বর্গ এবং পদ্ধতি নির্দেশ, সেইসাথে Meth, বর্গ, এবং func ভূমিকা. মডিউল নাম, একটি ডবল কোলন, এবং মডিউল মধ্যে বস্তুর ডট পৃথক পথ: অন্য বস্তুর উল্লেখ করার জন্য, এটি সম্পূর্ণরূপে যোগ্যতাসম্পন্ন নাম ব্যবহার করুন.
কফি: func: `lib / উইজেট :: swizzle``, উদাহরণস্বরূপ ফাইল` `lib / widgets.coffee``,` `লিখতে মধ্যে` `swizzle`` ফাংশন উল্লেখ করতে. আপনার প্রাথমিক ডোমেইন কফি সেট করা হয়েছে যদি coffee``, এবং আপনি `` lib / widgets`` মডিউল মধ্যে থেকে লিঙ্ক করা হয় IFF আপনি মডিউল নাম ড্রপ করতে পারেন: আপনি নেতৃস্থানীয় `` ড্রপ করতে পারেন.
Autodoc
আপনি সহজে `` automodule`` সঙ্গে সমগ্র মডিউল নথিতে করতে পারেন:
.. Sourcecode :: প্রথম
& Nbsp; .. Automodule :: mymodule
& Nbsp; & nbsp; & nbsp; : সদস্যদের
আবশ্যক
- পাইথন
পাওয়া মন্তব্যসমূহ না