باستخدام SPHINX إلى المستند التلقائي فئة بيثون، وحدة

Question

لقد ركبت أبو الهول من أجل توثيق بعض وحدات الثعبان والطبقة التي أعمل عليها. في حين أن لغة الترميز تبدو لطيفة جدا، إلا أنني لم تتمكن من توثيق رمز بيثون تلقائيا.

في الأساس، لدي وحدة بيثون التالية:

SegLib.py

وطبقة يسمى Seg فيه. أرغب في عرض DOCSTRINGS من الفصل والنمطية داخل مستند SPHINX الذي تم إنشاؤه، وأضف نصا أكثر تنسيقا إليه.

لي index.rst يشبه هذا:

Contents:

.. toctree::
:maxdepth: 2

chapter1.rst

و chapter1.rst:

This is a header
================
Some text, *italic text*, **bold text**

* bulleted list.  There needs to be a space right after the "*"
* item 2

.. note::
   This is a note.

See :class:`Seg`

ولكن Seg يتم طباعة فقط بالخط العريض، وغير مرتبط بتوثيق ذاتي للصف.

تحاول: انظر: الطبقة:Segالوحدة النمطية: وزارة الدفاع: "Segglib" وحدة: وزارة الدفاع: 'Seglib.py'

لم يساعد، أيضا. أي أفكار أو روابط تعليمية جيدة؟

تحرير: تغيير Seglib إلى شرائح (شكرا، Ielectric!)، وتغيير Chapter1.trst إلى:المزاج:segments وحدة --------------------------

.. automodule:: segments.segments

.. autoclass:: segments.segments.Seg

لا يزال، لا يمكن الحصول على أبو الهينكس لتحقيق الوظائف مباشرة داخل الفصل، أو أفضل - لإضافة جميع الوظائف تلقائيا داخل الفصل إلى المستند. حاول

.. autofunction:: segments.segments.Seg.sid

وحصلت:

autodoc can't import/find function 'segments.segments.Seg.sid', it reported error: "No module named Seg"

أي أفكار كيفية التبعية التلقائي الوظائف والفئات مع أمر قصير؟

UDI.

Answer 1

أضف إلى بداية الملف:

.. module:: SegLib

جرب استخدام : autoclass: التوجيه للطبقة الوثيقة.

BTW: يجب أن تكون أسماء الوحدة النمطية

تعديل: لقد تعلمت الكثير من قراءة ملفات المصدر الأخرى.