و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
الإخراج من التوجيه ويشمل
ونبسب؛ * اسم واجهة مؤهل بشكل كامل
ونبسب؛ * أي واجهات قاعدة
ونبسب؛ * وdoctstring من واجهة، كما تصدر reSTX.
ونبسب؛ * أعضاء واجهة (الأساليب والصفات).
على & nbsp؛ س لكل سمة، الإخراج يتضمن اسم السمة وصفه.
على & nbsp؛ س بالنسبة لكل طريقة، والإخراج يتضمن اسم الأسلوب، توقيعه، وdocstring لها (المقدمة أيضا باسم reSTX)
ما هو الجديد في هذا الإصدار:.
PyPy التوافق .
بيثون 3.2+ التوافق. بفضل Arfrever من أجل التصحيح.
تشمل مستندات واجهة تحت التوجيه automodule. بفضل Krys لورانس من أجل التصحيح.
ما هو الجديد في الإصدار 0.6.2:
إصلاح TypeError: الكائن 'NoneType' ليس خطأ iterable عند إنشاء جعل من واجهة تحت بيثون 2.7.
ما هو الجديد في الإصدار 0.6.1:
إصلاح ': أعضاء الترتيب: bysource "المناولة.
ما هو الجديد في الإصدار 0.6:
بشكل صحيح التعامل مع ': أعضاء: "القيم المحددة صراحة في التوجيه.
ما هو الجديد في الإصدار 0.5:
واضاف لدعم ': عضو النظام: "العلم، والتي يمكن أن تأخذ واحدة من القيم الأسهم الثلاثة، ومثل، الأبجدية ومثل ؛، & مثل ، غرووبويس ومثل ؛، أو & مثل؛ bysource & مثل ؛. افتراضيا، يتم توثيق أعضاء في ومثل، التجزئة ومثل. النظام.
المتطلبات:
بيثون
ابو الهول
لم يتم العثور على التعليقات