هذا هو الأمر epydocgui الذي يمكن تشغيله في مزود الاستضافة المجانية OnWorks باستخدام إحدى محطات العمل المجانية المتعددة على الإنترنت مثل Ubuntu Online أو Fedora Online أو محاكي Windows عبر الإنترنت أو محاكي MAC OS عبر الإنترنت
برنامج:
اسم
epydocgui - واجهة رسومية ل epydoc
موجز
com.epydocgui [مشروع. prj | نماذج...]
إبيدوك -h
إبيدوك -V
الوصف
com.epydocgui هي واجهة رسومية لـ epydoc ، والتي تنشئ وثائق API لبيثون
الوحدات والحزم ، بناءً على سلاسلها. لغة ترميز خفيفة تسمى
epytext يمكن استخدامها لتنسيق المستندات ، ولإضافة معلومات حول حقول معينة ،
مثل المعلمات ومتغيرات الحالة.
وثائق API التي تنتجها com.epydocgui يتكون من مجموعة من ملفات HTML. اثنين
يتم إنشاء الدلائل الفرعية للوثائق العامة والخاصة. داخل كل
الدلائل الفرعية ، يتم توثيق كل فئة ووحدة في ملف خاص بها. ملف فهرس ، أ
الأشجار ، ويتم أيضًا إنشاء ملف تعليمات. إذا قمت بتحديد ملف إطارات الخيار ، ثم أ
يتم أيضًا إنتاج جدول محتويات قائم على الإطارات.
OPTIONS
مشروع. prj
اسم ملف المشروع الذي تم حفظه بامتداد com.epydocgui. ملفات المشروع تسجل أ
قائمة الوحدات ذات الصلة ، والخيارات التي يجب استخدامها لإنشاء ملف
وثائق لتلك الوحدات.
نماذج
قائمة الوحدات التي يجب توثيقها. يمكن تحديد الوحدات باستخدام
أسماء الوحدات (مثل os.path) ، أسماء الملفات (مثل epydoc / epytext.py) أو دليل
أسماء (مثل إبيدوك /). تحدد أسماء الدلائل الحزم ، ويتم توسيعها إلى
تشمل جميع الوحدات الفرعية والحزم الفرعية.
-ح ، --يساعد، --استخدام ، -?
اعرض رسالة استخدام.
-الخامس، --الإصدار
اطبع نسخة Epydoc.
HTML FILES
وثائق API التي تنتجها إبيدوك يتكون من الملفات التالية:
index.html و
نقطة الدخول القياسية للوثائق. عادة، index.html و هو
ملف فهرس الإطارات ، والذي يحدد ثلاثة إطارات: إطاران على الجانب الأيسر من
يحتوي المستعرض على جدول محتويات ، والإطار الرئيسي على الجانب الأيمن
من النافذة يحتوي على صفحات التوثيق. ولكن إذا كان - لا إطارات الخيار
تستخدم ، إذن index.html و سيعيد توجيه المستخدم إلى الصفحة العليا للمشروع.
m-module.html
وثائق API للوحدة النمطية. وحدة هو الاسم الكامل المنقط لـ
وحدة ، مثل SYS or epydoc.epytext.
ج-class.html
وثائق API لفئة أو استثناء أو نوع. c هو الكامل
الاسم المنقط للفئة ، مثل epydoc.epytext.Token or صفيف.
الأشجار. html
التسلسل الهرمي للوحدة والفئات.
المؤشرات.html
فهارس المصطلح والمعرف.
help.html
صفحة المساعدة الخاصة بالمشروع. تشرح هذه الصفحة كيفية استخدام ملف
صفحة الويب التي تنتجها epydoc.
toc.html
صفحة جدول المحتويات ذات المستوى الأعلى. هذه الصفحة معروضة في أعلى اليسار
الإطار ، ويوفر روابط إلى toc-everything.html و توك- م-وحدة. HTML
الملفات. toc.html لا يتم إنشاء إذا كان - لا إطارات يستخدم الخيار.
toc-everything.html
جدول محتويات المشروع بأكمله. يتم عرض هذه الصفحة بتنسيق
الإطار الأيسر السفلي ، ويوفر روابط لكل فئة ، ونوع ، واستثناء ، ووظيفة ،
ومتغير يحدده المشروع. toc-everything.html لا يتم إنشاء إذا
القادم - لا إطارات يستخدم الخيار.
توك- م-وحدة. HTML
جدول محتويات وحدة. يتم عرض هذه الصفحة في أسفل اليسار
frame ، ويوفر روابط لكل فئة ونوع واستثناء ووظيفة و
متغير تحدده الوحدة. وحدة هو الاسم الكامل المنقط لـ
وحدة ، مثل SYS or epydoc.epytext. توك- م-وحدة. HTML لا يتم إنشاء إذا
القادم - لا إطارات يستخدم الخيار.
epydoc.css
تستخدم ورقة أنماط CSS لعرض كافة صفحات HTML.
افتراضيا، إبيدوك يُنشئ دليلين فرعيين في دليل الإخراج: جمهور و خاص.
يحتوي كل دليل على جميع الملفات المحددة أعلاه. ولكن إذا كان --لا خاص خيار
يتم استخدامه ، ثم لا يتم إنشاء أدلة فرعية ، ويتم كتابة التوثيق العام
مباشرة إلى دليل الإخراج. مقسم إلى خمس فئات: أخطاء الاستيراد ؛ epytext
أخطاء. تحذيرات epytext تحذيرات ميدانية وأخطاء الفحص. عندما يفير epydoc
يواجه خطأ ، ويصدر رسالة تحذير تصف الخطأ ، وتحاول
استمر في إنشاء الوثائق.
تشير أخطاء الاستيراد إلى أن epydoc لم يتمكن من استيراد وحدة. عادةً ما يتم استيراد الأخطاء
منع epydoc من إنشاء وثائق للوحدة المعنية. يمكن Epydoc
إنشاء أخطاء الاستيراد التالية:
مسبح وحدة الاسم وحدة
حاولت Epydoc الاستيراد وحدة، لكن وحدة ليس اسمًا صالحًا لبايثون
وحدة.
يمكن ليست جد a UID لـ رابط الهدف
تعذر على Epydoc العثور على الكائن المشار إليه ببناء ارتباط مضمن
(ل {...}). يحدث هذا عادةً بسبب خطأ مطبعي في الارتباط.
يمكن ليست استيراد وحدة
حاولت Epydoc الاستيراد وحدةلكنها فشلت. يحدث هذا عادة عندما
وحدة يثير استثناء.
ملف هل ليست يوجد
حاولت Epydoc استيراد الوحدة المضمنة في ملف، لكن ملف لا
يوجد.
تحدث أخطاء النص الموضوعي بسبب سلاسل مستندات النص المُلحق التي تحتوي على ترميز غير صالح. كلما كان
تم اكتشاف خطأ في النص ، يتم التعامل مع سلسلة المستندات المعنية على أنها سلسلة مستندات نص عادي.
يمكن أن يولد Epydoc أخطاء النص النصي التالي:
مسبح الصفحة استهداف.
الهدف المحدد لإنشاء ارتباط مضمن (ل {...}) ليس جيدا-
شكلت. يجب أن تكون أهداف الارتباط معرّفات بيثون صالحة.
مسبح أوري استهداف.
الهدف المحدد لإنشاء uri مضمن (أنت {...}) غير منسق بشكل جيد.
يحدث هذا عادةً إذا كانت العلامات المضمنة متداخلة داخل هدف URI.
مجال يجب be at القادم تيشرت .
قائمة الحقول (param، وما إلى ذلك) تم احتوائه بواسطة بعض بنية الكتلة الأخرى
(مثل قائمة أو قسم).
مجال يجب be القادم نهائي العناصر.
قائمة الحقول (param، وما إلى ذلك) ليس في نهاية سلسلة docstring.
العناوين يجب حدث at تيشرت .
يتم احتواء العنوان في بنية كتلة أخرى (مثل القائمة).
غير مناسب دوكت منع المسافة الفارغة.
كتلة العقيدة تتجاوز المسافة البادئة لسطر المطالبة الأولي الخاص بها.
غير مناسب عنوان المسافة الفارغة.
عنوان مقطع غير محاذاة إلى اليسار مع الفقرات الموجودة في
القسم الذي يحتوي عليه.
غير مناسب فقرة المسافة الفارغة.
لم يتم محاذاة الفقرات داخل كتلة إلى اليسار. غالبًا ما يكون هذا الخطأ
تم إنشاؤه عندما يتم تحليل سلاسل مستندات النص العادي باستخدام النص الفوري.
باطل هرب.
تم استخدام تسلسل هروب غير معروف مع إنشاء إلغاء مضمن
(ه {...}).
قوائم يجب be مسافة بادئة.
يبدأ السطر غير المُزود بمسافة بادئة بعد الفقرة مباشرةً برمز قائمة نقطي.
Epydoc ليس متأكدًا مما إذا كنت تقصد بدء عنصر قائمة جديد ، أو المقصود بامتداد
فقرة لتضمين كلمة تشبه الرمز النقطي. إذا كنت تقصد
السابق ، ثم مسافة بادئة للقائمة. إذا كنت تقصد هذا الأخير ، فقم بتغيير
التفاف الكلمة في الفقرة ، أو الهروب من الحرف الأول من الكلمة التي
يشبه الرصاصة.
غير متوازن "{".
يحتوي docstring على أقواس غير متوازنة. Epytext يتطلب أن جميع الأقواس
يجب أن تكون متوازنة. لتضمين دعامة واحدة غير متوازنة ، استخدم مفتاح الهروب
التسلسلان E {lb} (قوس أيسر) و E {rb} (قوس أيمن).
غير متوازن "}".
يحتوي docstring على أقواس غير متوازنة. Epytext يتطلب أن جميع الأقواس
يجب أن تكون متوازنة. لتضمين دعامة واحدة غير متوازنة ، استخدم مفتاح الهروب
التسلسلان E {lb} (قوس أيسر) و E {rb} (قوس أيمن).
غير معروف مضمنة وضع علامة على العلامة.
تم استخدام علامة غير معروفة مع إنشاء العلامات المضمنة ( x{...} ).
خاطئ أكد حرف لـ عنوان.
لا يشير حرف التسطير المستخدم لعنوان القسم هذا إلى
مستوى القسم المناسب. يجب استخدام الحرف "=" للتسطير
أقسام. "-" للأقسام الفرعية ؛ و "~" للأقسام الفرعية.
تنجم تحذيرات Epytext عن سلاسل نصوص ذات نصوص تحتوي على مشكوك فيها أو مشبوهة
وضع علامة على. تحذيرات Epytext تفعل ليست منع docstring المعني من التحليل.
يمكن أن يولد Epydoc التحذيرات التالية للنصوص اللاصقة:
ممكن سيء التنسيق حقل البند.
اكتشفت Epytext سطرًا يبدو كعنصر حقل ، ولكن ليس بشكل صحيح
منسق. يحدث هذا عادةً عندما لا يتم تضمين النقطتين اللاحقتين (":")
في علامة الحقل.
ممكن عنوان خطأ مطبعي.
اكتشف Epytext زوجًا من الأسطر يشبه العنوان ، ولكن عدد
لا تتطابق أحرف التسطير مع عدد الأحرف في العنوان.
يجب أن يتطابق عدد الأحرف في هذين السطرين تمامًا حتى يكونا
يعتبر عنوان.
تنجم التحذيرات الميدانية عن سلاسل مستندات نصية تحتوي على حقول غير صالحة. محتويات
بشكل عام يتم تجاهل من الحقل غير صالح. يمكن لـ Epydoc إنشاء الحقل التالي
تحذيرات:
param لـ غير معروف المعلمة المعلمة.
تم استخدام حقلparam لتحديد نوع معلمة ليست كذلك
المدرجة في توقيع الوظيفة. يحدث هذا عادةً بسبب خطأ إملائي في
اسم المعلمة.
بطاقة فعل ليست توقع an جدال.
علامة الحقل بطاقة تم استخدامه مع حجة ، لكنها لا تأخذ واحدة.
بطاقة متوقع an جدال.
علامة الحقل بطاقة تم استخدامه بدون جدال ، لكنه يتطلب واحدًا.
@يكتب لـ غير معروف المعلمة المعلمة.
تم استخدام حقلtype لتحديد نوع المعلمة التي لم يتم تضمينها
في توقيع الوظيفة. يحدث هذا عادةً بسبب خطأ مطبعي في
اسم المعلمة.
@يكتب لـ غير معروف متغير فار.
تم استخدام حقلtype لتحديد نوع متغير ، ولكن لم يتم استخدام حقل آخر
المعلومات معروفة عن المتغير. يحدث هذا عادةً بسبب خطأ إملائي في
اسم المتغير.
غير معروف حقل بطاقة بطاقة.
يحتوي docstring على حقل بعلامة غير معروفة بطاقة.
إعادة تعريف of حقل.
تحدد علامات الحقول المتعددة قيمة حقل في نفس سلسلة الوثائق ، ولكن حقل
يمكن أن تأخذ قيمة واحدة فقط.
يتم إنشاء أخطاء الاستقصاء إذا واجهت epydoc مشاكل أثناء محاولة الفحص
خصائص كائن موثق. معظم أخطاء الفحص لا تمنع epydoc
من توثيق الكائن المعني. يمكن أن تنشئ Epydoc الفحص التالي
الأخطاء:
ال المعلمات of طريقة do ليست مباراة الأسلوب الأساسي.
معلمات الطريقة غير الموثقة طريقة لا تتطابق مع المعلمات
لطريقة الطبقة الأساسية الأسلوب الأساسي أنه يتجاوز. نتيجة ل، طريقة
لا ترث الوثائق من الأسلوب الأساسي. إذا كان الاختلاف في
المعلمات مقصودة ، ثم يمكنك إزالة التحذير عن طريق إضافة
(ربما فارغة) docstring إلى طريقة.
دوكماب لا تستطيع تضيف a نوع
حاول Epydoc توثيق كائن بنوع غير معروف. هذا الخطأ
يتم إنشاؤها عادةً بواسطة الحزم والوحدات النمطية التي تتعامل مع الاستيراد
آلية ، مثل أن يؤدي استيراد وحدة نمطية إلى إنتاج نوع آخر من الكائنات.
UID صراع مُكتَشَف: رقم تعريف الوحدة
تم تعيين كائنين مختلفين نفس المعرف الفريد بواسطة epydoc. هذا
يمكن أن يتسبب في استبدال epydoc لوثائق كائن واحد بامتداد
توثيق كائن آخر تم تخصيص نفس المعرف الفريد له.
ومع ذلك ، فإن هذا عادة ما يسبب مشاكل فقط إذا كان الكائنان بهما نفس الشيء
المعرّفات الفريدة هي وحدات أو فئات ، وفي هذه الحالة واجهة برمجة التطبيقات
ستحل صفحة التوثيق لكائن واحد محل صفحة وثائق API الخاصة بـ
الكائن الآخر.
موضوع يبدو in متعدد المضمن نماذج
أثناء محاولة تحديد الوحدة النمطية التي تحدد الكائن المضمن موضوع,
واجهت epydoc عدة مرشحين ، ولم تتمكن من تحديد أي منها
كان المرشح على صواب. في هذه الحالة ، يختار epydoc بشكل تعسفي الأول
المرشح الذي يجد.
موضوع يبدو in متعدد .py نماذج
أثناء محاولة تحديد الوحدة النمطية التي تحدد الكائن المضمن موضوع,
واجهت epydoc عدة مرشحين ، ولم تتمكن من تحديد أي منها
كان المرشح على صواب. في هذه الحالة ، يختار epydoc بشكل تعسفي الأول
المرشح الذي يجد.
موضوع يبدو in متعدد .وبالتالي نماذج
أثناء محاولة تحديد الوحدة النمطية التي تحدد الكائن المضمن موضوع,
واجهت epydoc عدة مرشحين ، ولم تتمكن من تحديد أي منها
كان المرشح على صواب. في هذه الحالة ، يختار epydoc بشكل تعسفي الأول
المرشح الذي يجد.
يمكن ليست جد a وحدة لـ موضوع
كان Epydoc غير قادر على تحديد أي وحدة تعرف موضوع. إذا موضوع هو
وظيفة ، فهذا سيمنع epydoc من إنشاء أي وثائق لـ
موضوع، لأنه لا يعرف الصفحة التي سيتم وضع الوثائق عليها.
خلاف ذلك ، سيؤدي هذا إلى منع وثائق موضوع من تضمين ارتباط
إلى الوحدة التي تحتوي عليها.
استخدم epydocgui عبر الإنترنت باستخدام خدمات onworks.net
