Sphinx Autodoc y NumpyDoc

python-sphinx

Question

A pesar de leer este tutorial , esta pregunta y el estándar de la cadena de documentación de números , no puedo hacer que sphinx autodoc juegue bien con las cadenas de datos de números.

En mi conf.py tengo:

extensions = [''sphinx.ext.autodoc'', ''numpydoc'']

y en mi archivo doc tengo:

 .. automodule:: python_file

 .. autoclass:: PythonClass
   :members:

donde python_file.py tiene:

class PythonClass(object):
    def do_stuff(x):
        """
        This does good stuff.

        Here are the details about the good stuff it does.

        Parameters
        ----------
        x : int
            An integer which has amazing things done to it

        Returns
        -------
        y : int
            Some other thing
        """
        return x + 1

Cuando ejecuto make html obtengo ERROR: Unknown directive type "autosummary" . Cuando agrego autosummary a mis extensions así:

extensions = [''sphinx.ext.autodoc'', ''numpydoc'', ''sphinx.ext.autosummary'']

Yo obtengo:

WARNING: toctree references unknown document u''docs/python_file.PythonClass.do_stuff''

Según lo recomendado por esta pregunta , agrego numpydoc_show_class_members = False a mi conf.py

Ahora puedo ejecutar make html sin errores, pero las secciones Parameters y Returns no se interpretan como secciones numpydoc.

¿Hay alguna manera de salir de este lío?

Answer 1

Trate de eliminar toda la salida html anterior. Luego regenera los documentos.