وsphinxcontrib القهوة هو امتداد أبو الهول أن يضيف مجال CoffeeScript بدعم autodoc من تمثال أبو الهول.
هذا يعتمد على coffeedoc_ لاستخراج تصريحات مصدر من `` الملفات .coffee``. لتثبيت coffeedoc عالميا ::
على & nbsp؛ الآلية تثبيت coffeedoc -g
.. _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 = 'القهوة'
توجيهات والأدوار
يوفر هذا النطاق وحدة، وظيفة، والطبقة وطريقة التوجيهات، فضلا عن المنهجيات، والطبقة، والأدوار وظائفها لالإحالة المرجعية. من أجل مرجع كائن آخر، واستخدامها اسم مؤهل بشكل كامل: اسم وحدة، والقولون مزدوج، ونقطة مسار منفصل إلى كائن ضمن الوحدة النمطية.
على سبيل المثال، إلى مرجع `` وظيفة swizzle`` في ملف `` ليب / widgets.coffee``، والكتابة ``: القهوة: ظائفها: `ليب / الحاجيات :: swizzle``. يمكنك إسقاط الرائدة ``: coffee`` إذا تم تعيين المجال الأساسي الخاص بك إلى القهوة، ويمكنك إسقاط اسم الوحدة النمطية IFF كنت الارتباط من داخل `` ليب / وحدة widgets``.
Autodoc
يمكنك توثيق كامل وحدات بسهولة مع `` automodule``:
.. :: المصدرية RST
على & nbsp؛ .. :: automodule mymodule
على & nbsp؛ على & nbsp؛ على & nbsp؛ : أعضاء:
المتطلبات:
بيثون
لم يتم العثور على التعليقات