software - ¿Hay un campo de documentación de Sphinx reST en Python para rendimientos?
sphinx tutorial español (2)
He revisado la otra respuesta y en mi opinión no responde la pregunta.
La forma de documentar un generador, aunque no es la mejor, es usando :return como en el resto de los documentos. Usa la descripción para avisar que es un generador.
Los rendimientos de los documentos de estilo Google / Numpy convierten los rendimientos en cláusulas de retorno.
Estoy tratando de usar cadenas de documentación de estilo reST, es decir
def foo(bar):
"""a method that takes a bar
:param bar: a Bar instance
:type bar: Bar
¿Hay una forma estándar de documentar los yields ? Miré http://sphinx-doc.org/domains.html#info-field-lists , a-la esta pregunta [ Uso de javadoc para la documentación de Python ], pero no hay suerte. Estoy imaginando algo como
:yields: transformed bars
:yield type: Baz
¡Gracias!
Python 3.5 Iterator[] anotación
Ofrecen una sintaxis Iterator[] estandarizada para esto como se documenta en: https://docs.python.org/3/library/typing.html#typing.Generator
Antes de Python 3, te recomiendo que uses esta sintaxis para que sea más fácil de migrar más adelante:
from typing import List
def f():
"""
:rtype: Iterator[:class:`SomeClass`]
"""
yield SomeClass()
Y después de Python 3, use https://pypi.python.org/pypi/sphinx-autodoc-annotation con sintaxis:
from typing import Iterator
def f() -> Iterator[SomeClass]:
yield SomeClass()