nb autodoc

NB-Autodoc

تبسيط اللغة الإنجليزية الصينية

مقدمة

NB-AUTODOC هي أداة تقوم تلقائيًا بإنشاء مستندات API من التعليقات التوضيحية من نوع رمز Python و DOCSTRING.

تجد هذه الأداة جميع الوحدات النمطية من الحزمة وتستوردها ، وتستوعب شجرة بناء الجملة المجردة ، ونوع وقت التشغيل لكل وحدة ، وربط الكائنات الداخلية ، وتوقيعات وظائف التحليلات وأشجار بناء الجملة Docstring ، وأخيراً توليد مستند API كامل وموثوق به وربط.

الميزات الرئيسية

• نظام تحليل النوع المستند إلى AST

• يعرض النوع الحديث ، مثل X | Y ، list[str] ، (*args) -> Any

• كعب (.pyi) الدعم

• sype_checking الدعم

• إعادة تصدير الدعم ، استيراد المراجع من AST

• دعم وظيفة التحميل الزائد

الاستخدام

التثبيت من PIP:

 pip install nb-autodoc

تشغيل NB-Autodoc:

 nb-autodoc {package_name}

خيارات سطر الأوامر الأخرى:

 Usage: nb-autodoc [OPTIONS] MODULE

Options:
  -o, --output-dir DIRECTORY      [default: build]
  -s, --skip TEXT                 skip import modules
  -u, --undoc TEXT                undocument modules
  --markdown-linkmode [heading_id|vuepress]
                                  [default: heading_id]
  --help                          Show this message and exit.

نصيحة: استخدام --undoc بدلاً من --skip ، والتي سوف تتخطى استيراد وتحليل الوحدات النمطية.