توثيق الهيئات الوحدة / الفئة / الوظائف في وثائق Python Sphinx

StackOverflow https://stackoverflow.com/questions/1836633

سؤال

هل هناك طريقة مع وثائق أبو الهول لإخراج وظيفة أو جسم فئة (الكود نفسه) مع ميزة Autodoc؟ أنا أستخدم Autodoc إلى نجاح كبير. بالإضافة إلى سحب DocStrings إلى الوثائق التي أريدها الرابط النقر لأحد الوظائف حيث سيظهر لك المصدر ... هل هذا ممكن؟

هذا يدور حول ما يبدو فيه معظم وثائقي الآن:

   .. module:`foo.mymodule`

    Title
    ===================


    .. automodule:: foo.mymodule

    .. autoclass:: MyModulesClass
        :members:
        :undoc-members:
هل كانت مفيدة؟

المحلول

إذا كان هذا لا يزال يهم: تمديد المقصات يمكن القيام بذلك، ولكن يحتاج إلى إصدار التطوير (1.0) من أبو الهول

نصائح أخرى

أنا لا أصدق ذلك. Autodoc فقط لسحب الوثائق من التعليمات البرمجية المصدر.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top