repoze.sphinx.autointerface מגדיר ארכה למערכת תיעוד הספינקס & nbsp;. הסיומת מאפשרת דור של תיעוד API על ידי התבוננות פנימית של מקרי zope.interface בקוד.
התקנה:
התקן באמצעות easy_install:
bin / repoze.sphinx.autointerface easy_install
או בכל אמצעי אחר שמקבל את החבילה על PYTHONPATH שלך.
רישום סיומת
להוסיף repoze.sphinx.autointerface לרשימת הסיומות בconf.py של תיעוד הספינקס עבור המוצר שלך. E.g .:
= סיומות ['sphinx.ext.autodoc',
& Nbsp; 'sphinx.ext.doctest',
& Nbsp; 'repoze.sphinx.autointerface',
& Nbsp;]
שימוש בסיומת
בנקודות מתאימות במסמך, קורא autodocs הממשק באמצעות:
.. :: Autointerface yourpackage.interfaces.IFoo
פלט מההוראה כולל
& Nbsp; * שם ממשק מלא המוסמך
& Nbsp; * כל ממשקי בסיס
& Nbsp; * doctstring מהממשק, כפי שניתן reSTX.
& Nbsp; * החברים של הממשק (שיטות ותכונות).
& Nbsp; o לכל תכונה, הפלט כולל את שם התכונה ותיאורו.
& Nbsp; o לכל אחת משיטות, התפוקה כוללת את שם השיטה, חתימתו, וdocstring (גם כפי שניתן reSTX)
מה חדש במהדורה זו:. <>
- .
- Python תאימות 3.2+. תודה לArfrever לתיקון.
- כלול מסמכי ממשק תחת הוראת automodule. תודה לKrys לורנס לתיקון.
מה חדש בגרסה 0.6.2:
- TypeError תקן: האובייקט 'NoneType' הוא לא iterable שגיאה בעת יצירת טיוח של ממשק תחת Python 2.7.
מה חדש בגרסת 0.6.1:
- תקן ': חבר-מנת: bysource' טיפול .
מה חדש בגרסת 0.6:
- מטפל כהלכה ': חברים: "ערכים שנקבעו באופן מפורש ב הוראה.
מה חדש בגרסת 0.5
: דגל
- תמיכה נוסף עבור ':: חבר-מנת' , אשר יכול לקחת אחד משלושת ערכי המניות, & quot; א"ב & quot ;, & quot; GroupWise & quot ;, או & quot; bysource & quot ;. כברירת מחדל, חברים מתועדים ב& quot; חשיש & quot; כדי.
דרישות :
- Python
- הספינקס
תגובות לא נמצא