python-2.7 - readthedocs - sphinx python download

¿Cómo debo documentar listas, opcionales y rendimientos con Sphinx al estilo de Google?

Question

¿Cómo puedo indicar los tipos de listas, argumentos opcionales y tipos de devolución para generadores en documentos de Google usando Sphinx-Napoleon?

He intentado

List[type]
list of type
Optional[type]
type, optional

y

Yields:
type:

respectivamente; pero todos producen resultados insatisfactorios que no son consistentes con el resto de la documentación generada. Por ejemplo

Optional[type]

solo da

Opcional [tipo]

sin ningún enlace por type .

Probé todos los temas integrados y tengo los mismos problemas.

¿Cómo debería documentar estos elementos usando docstrings estilo Google con Sphinx-Napoleon?

Answer 1

Sé que esto es bastante viejo, pero ¿echó un vistazo a sphinxcontrib-napoleon.readthedocs.io/en/latest/… ? Particularmente líneas:

def __init__(self, param1, param2, param3):
"""Example of docstring on the __init__ method.
The __init__ method may be documented in either the class level
docstring, or as a docstring on the __init__ method itself.
Either form is acceptable, but the two should not be mixed. Choose one
convention to document the __init__ method and be consistent with it.
Note:
Do not include the `self` parameter in the ``Args`` section.
Args:
param1 (str): Description of `param1`.
param2 (:obj:`int`, optional): Description of `param2`. Multiple
lines are supported.
param3 (:obj:`list` of :obj:`str`): Description of `param3`.
"""
self.attr1 = param1
self.attr2 = param2
self.attr3 = param3 #: Doc comment *inline* with attribute
#: list of str: Doc comment *before* attribute, with type specified
self.attr4 = [''attr4'']
self.attr5 = None
"""str: Docstring *after* attribute, with type specified."""