.
repoze.sphinx.autointerface فرمت برای سیستم مستند سازی مجسمه ابوالهول و nbsp تعریف می کند. فرمت اجازه می دهد تا نسل از مستندات API های درون گرایی از موارد zope.interface در کد.
نصب و راه اندازی:
نصب از طریق easy_install:
بن / repoze.sphinx.autointerface easy_install
و یا هر وسیله دیگر که می شود بسته در PYTHONPATH خود را.
ثبت نام فرمت
اضافه کردن repoze.sphinx.autointerface به لیست پسوند در conf.py اسناد مجسمه ابوالهول برای محصول خود را. مثال:
پسوند = ['sphinx.ext.autodoc،
& nbsp؛ در 'sphinx.ext.doctest،
& nbsp؛ در 'repoze.sphinx.autointerface،
و nbsp؛]
با استفاده از فرمت
در نقاط مناسب در سند خود، از تماس autodocs رابط از طریق:
.. autointerface :: yourpackage.interfaces.IFoo
خروجی از دستور شامل
را لمس کنید و؛ * نام رابط به طور کامل واجد شرایط
و nbsp؛ * هر رابط پایه
و nbsp؛ * doctstring از رابط، ارائه به عنوان reSTX.
و nbsp؛ * اعضای رابط (روش ها و ویژگی های).
& nbsp؛ در درجه برای هر ویژگی، خروجی شامل نام ویژگی و توضیحات آن.
را لمس کنید و. ای برای هر یک از روش، خروجی شامل نام روش، امضا خود را، و رشته مستندساز آن (همچنین به عنوان reSTX ارائه)
چه در این نسخه جدید است.
پایپای سازگاری .
پایتون 3.2+ سازگاری. با تشکر از برای پچ Arfrever.
شامل اسناد رابط تحت بخشنامه automodule. با تشکر از Krys لارنس برای پچ.
جدید در نسخه 0.6.2 است:
در رفع TypeError: شی 'NoneType است خطا iterable نیست که تولید یک ارائه یک رابط تحت پایتون 2.7.
رفع ':: عضو منظور: bysource' دست زدن به
جدید در نسخه 0.6.1 است.
جدید در نسخه 0.6 است:
به درستی رسیدگی ': اعضا: "ارزش به صراحت در بخشنامه تنظیم شده است.
چه در نسخه 0.5 جدید است:
اضافه شدن پشتیبانی برای ': عضو منظور:' پرچم، که می تواند یکی از سه ارزش سهام، و & quot را. بر اساس حروف الفبا & quot؛ باشد و & quot . GROUPWISE & quot؛ باشد یا & quot؛ bysource و quot؛ کلیک کنید به طور پیش فرض، اعضای در & quot مستند، هش ها & quot؛ منظور.
مورد نیاز:
پایتون
مجسمه ابوالهول
نظر یافت نشد