الوثائق الخارجية لـ PHP ، لا Docbook

Question

أحتاج إلى نظام توثيق لمشروع PHP وأردت أن يكون قادرًا على دمج الوثائق الخارجية (حالات الاستخدام ونطاق المشروع وما إلى ذلك) مع الوثائق التي تم إنشاؤها من تعليقات التعليمات البرمجية. يبدو أن Phpdocumentor لديه مجموعة الميزات الصحيحة تمامًا ، ولكن يجب كتابة الوثائق الخارجية في Docbook وهي معقدة للغاية لفريقنا.

إذا كان في بيثون ، فإن أبو الهول سيكون مثالياً لهذه الوظيفة (الباقي بالتأكيد أبسط من Docbook). هل هناك أي طريقة يمكنني من خلالها دمج وثائق الراحة الخارجية مع المستندات المستخرجة من PHPDOC؟ هل يجب أن أفصل الوثائق الخارجية (على سبيل المثال ، استخدم REST لـ External و PHPDOC للداخلية)؟ أو هل لديك اقتراح أفضل لإدارة الوثائق الخارجية؟

Answer 1

يمكنك تحويل REST إلى Docbook باستخدام Pandoc.

Answer 2

تحويل منشورات WordPress في نمط docbook. ها هي العينة.

http://hashfold.com/techfold/wordpress-how-to-generate-docbook-style-posts/