how - sphinx python download

Usando la esfinge para documentar automáticamente una clase de python, módulo

Question

He instalado Sphinx para documentar algunos módulos de Python y la clase en la que estoy trabajando. Si bien el lenguaje de marcado se ve muy bien, no he logrado documentar automáticamente un código de Python.

Básicamente, tengo el siguiente módulo de python:

SegLib.py

Y una clase llamada Seg en ella. Me gustaría mostrar las cadenas de documentación de la clase y el módulo dentro del documento generado con esfinge, y agregarle más texto con formato.

Mi index.rst ve así:

Contents:

.. toctree::
:maxdepth: 2

chapter1.rst

y 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`

Pero Seg solo se imprime en negrita y no está vinculado a una documentación autogenerada de la clase.

Probar: ver: clase: Seg Módulo: mod: ''SegLib'' Módulo: mod: ''SegLib.py''

No ayudó, también. ¿Alguna idea o buenos enlaces tutoriales?

Editar: cambié SegLib a segmentos (gracias, iElectric!), Y cambié chapter1.rst a : Mod: segments Módulo ------------------------ -

.. automodule:: segments.segments

.. autoclass:: segments.segments.Seg

Aún así, no puede hacer que la esfinge documente funciones directamente dentro de una clase, o mejor aún, para agregar automáticamente todas las funciones dentro de una clase al documento. Intentó

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

y consiguió:

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

¿Alguna idea de cómo autodocumentar las funciones y clases con un comando corto?

Udi

Answer 1

Añadir al inicio del archivo:

.. module:: SegLib

Trate de usar : autoclass: directiva para la clase doc.

Por cierto: los nombres de los módulos deben ser lower_case.

EDITAR: Aprendí mucho al leer otros archivos de origen .