show * only * docstring en la documentación de Sphinx

Question

Sphinx tiene una función llamada automethod que extrae la documentación de la cadena de documentación de un método y la incorpora a la documentación. Pero no solo incluye la docstring, sino también la firma del método (nombre + argumentos). ¿Cómo incrusto solo la docstring (excluyendo la firma del método)?

ref: http://sphinx.pocoo.org/ext/autodoc.html

Answer 1

creo que lo que estás buscando es:

from sphinx.ext import autodoc 

class DocsonlyMethodDocumenter(autodoc.MethodDocumenter): 
    def format_args(self): 
    return None 

autodoc.add_documenter(DocsonlyMethodDocumenter) 

por the current sources Esto debería permitir anulando lo que la clase es responsable de documentar métodos (las versiones anteriores de add_documenter prohibieron tales redefiniciones, pero ahora están explícitamente permitidos). Tener format_args return Ninguno, por supuesto, es EL modo documentado en autodoc para decir "no molestar con la firma".

Creo que esta es la manera limpia y estructurada para realizar esta tarea y, como tal, es preferible a las alternativas de monopatching. Si necesita vivir con algunas versiones anteriores de sphinx, sin embargo, es posible que tenga que parchear (autodoc.MethodDocumenter.format_args=lambda _:None - eek! -) aunque le recomendaría actualizar sphinx a la versión actual como un mejor enfoque si es factible en su implementación específica.