Anular la declaración de función en autodoc para esfinge
Tengo un módulo que dice algo como esto:
#!/usr/bin/env python
#: Documentation here.
#: blah blah blah
foobar = r'Some really long regex here.'
def myfunc(val=foobar):
'''Blah blah blah'''
pass
... y tengo un.rst
archivo que va algo como esto:
:mod:`my_module` Module
-----------------------
..automodule:: my_module
:members:
:private-members:
:show-inheritance:
Cuando compilo la documentación, obtengo un archivo html con un fragmento que dice así:
mymodule.foobar.foobar = 'Algunos regex absurdamente largos y feos aquí'
Documentación adicional aquí
mymodulemi función(val = 'Un regex absurdamente largo y feo aquí')
bla, bla, bla
Basado en estopost stackoverflow, Pensé que podía cambiarlo modificando mi módulo a:
#!/usr/bin/env python
#: .. data:: my_module.foobar
#: Extra documentation here
foobar = 'Some really long regex here.'
def myfunc(val=foobar):
'''.. function:: my_module.myfunc(val=foobar)
Blah blah blah'''
pass
... pero eso no sirvió de nada, y simplemente adjunté la firma que quería debajo de la fea como parte del cuerpo. ¿Alguien sabe cómo puedo anular esto correctamente?
(Estoy usando Sphinx v1.1.3, por cierto).