autodoc

6El calor

2Respuesta

Usando sphinx autodoc para un fabfile

¿Es posible usar Sphinx autodoc para generar documentación para mi fabfile, desde la función docstrings? E.g. para un fabfile que contiene una tarea setup_development he intentado: .. automodule::fabf

python python-sphinx fabric autodoc 2012-01-13

---

9El calor

1Respuesta

Incluyendo docstring en Sphinx Documentation

Me gustaría incluir solo el docstring de una función específica en mi documentación de Sphinx. Sin embargo, parece que no hay opciones para mostrar estos detalles sin definiciones de clases y funcione

python python-sphinx autodoc 2011-10-19

---

5El calor

1Respuesta

autoclase y atributos de instancia

De acuerdo con sphinx documentation, la directiva .. autoattribute debe ser capaz de documentar atributos de instancia. Sin embargo, si lo hago :: .. currentmodule:: xml.etree.ElementTree .. autocla

python python-sphinx autodoc 2012-06-26

---

9El calor

1Respuesta

Sphinx autodoc da ADVERTENCIA: py: target de referencia de clase no encontrado: tipo advertencia

Tengo un código que usa una metaclase en python. Pero cuando se ejecuta autodoc esfinge que está dando el error: WARNING: py:class reference target not found: type El error está ocurriendo en una líne

python python-sphinx metaclass autodoc 2012-07-10

---