در sphinxcontrib-قهوه فرمت مجسمه ابوالهول می افزاید که یک دامنه کافیاسکریپت با پشتیبانی autodoc به مجسمه ابوالهول است.
این متکی به coffeedoc_ برای استخراج منابع از `` فایل .coffee``. برای نصب coffeedoc در سطح جهان ::
و nbsp؛ NPM نصب 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 ('../)
در نهایت، اگر پروژه شما می باشد در درجه اول کافیاسکریپت، شما ممکن است بخواهید برای تعریف دامنه اصلی و همچنین:
و nbsp؛ primary_domain = 'قهوه'
بخشنامه ها و نقش ها
این دامنه را فراهم می کند ماژول، تابع، کلاس و روش دستورات، و همچنین به عنوان مت، طبقه، و نقش تابع برای ارجاعات متقابل. به منظور مرجع یکی دیگر از جسم، استفاده از آن نام به طور کامل واجد شرایط است: نام ماژول، روده بزرگ دو برابر و نقطه مسیر جداگانه به شیء در داخل ماژول.
به عنوان مثال، به مرجع `` تابع swizzle`` در فایل `` معاونت / widgets.coffee``، ارسال ``: قهوه: تابع: `معاونت / ویدجت :: swizzle``. coffee`` اگر دامنه اصلی شما شده است به قهوه مجموعه، و شما می توانید نام ماژول رها IFF شما از درون `` معاونت / ماژول widgets`` ارتباط: شما می توانید پیشرو `` رها.
Autodoc
شما می توانید تمام ماژول به راحتی با `` automodule`` مستند:
.. sourcecode :: اول
و nbsp؛ .. automodule :: mymodule
و nbsp؛ & nbsp؛ در و nbsp؛ : اعضا:
مورد نیاز:
پایتون
نظر یافت نشد