ما هي العلاقة بين Docutils و SPHINX؟

Question

يبدو أن هناك عدد كبير من أدوات الوثائق لبيتثون. شخص آخر قمت بتشغيله هو epydoc. يبدو أن SPHINX هو المعيار الفعلي، لأنه يستخدم لإنشاء مستندات Python الرسمية. يمكن لشخص ما الرجاء فرز الحالة الحالية لأدوات وثائق بيثون بالنسبة لي؟

Answer 1

epydoc. و أبو الهول هي أنواع مختلفة من الأدوات.

هم نفس الشيء في أنهم:

• كلا الاستخدام راحة عبر Docutils..
• كلاهما يبرثون جدا في تركيزهم
• يمكن كلاهما إنشاء وثائق HTML و PDF

أنها مختلفة في تركيزهم.

• يركز Epydoc على وثائق API (المطور). تحصل على نتائج أكثر أسرع مع Epydoc. يمكنك توجيهها في شفرة المصدر الخاصة بك وتحصل على شيء ما. هذا هو ما أريده من أداة وثائق API.
• يركز SPHINX على وثائق عامة (مستخدم). بينما تسحب أبو الهول الكثير من المعلومات من التعليمات البرمجية المصدرية التي تحتاجها لوضعها أكثر قليلا. يمكن أن تقوم SPHINX بإنشاء وثائق API ولكنها ليست مستقيمة إلى الأمام، ولا تعمل المنظمة البحرية الدولية على أنها جيدة من وظيفة مثل Epydoc. أعلم أن البعض سوف يختلف بسبب اختيار أبو الهول بيثون. وبعد ولكن ذلك يعتمد على مقدار العمل الذي تريد وضعه فيه. أنا أحب أبو الهول للوثائق العامة.

لذلك يعتمد ذلك على مقدار العمل الذي تريد وضعه فيه وما تقوم بتوثيقه.

Answer 2

لقد تغيرت مؤخرا من Python2 إلى Python3 ووجدت أنه لم يكن هناك حزمة Epydoc لبيدثون 3. لذلك يبدو مع Python3 هناك تركيز واضح على استخدام SPHINX كوثائق API.

Answer 3

انها تبدو مثل epydoc. هو، إن لم يكن ميتا، على الأقل تثبيت fjords.

sphynx مع أبيدوك القيادة و Autodoc. يبدو أن التمديد هو الخيار الأكثر شعبية لمستندات API في هذا الوقت.

أمثلة جيدة هي:

• طلبات (SRC.)
• بوتو (SRC.)

يرى: يجب أن نستخدم Epydoc، أبو الهول أو شيء آخر لتوثيق Python Apis؟ (SO5579198)

يشجع أبو الهول على أسلوب سرد أكثر من الأدوات في قالب جافادوك، ولكن ربما هذا شيء جيد؟