Переопределить объявление функции в autodoc для sphinx
У меня есть модуль, который выглядит примерно так:
#!/usr/bin/env python
#: Documentation here.
#: blah blah blah
foobar = r'Some really long regex here.'
def myfunc(val=foobar):
'''Blah blah blah'''
pass
... и у меня есть.rst
файл, который выглядит примерно так:
:mod:`my_module` Module
-----------------------
..automodule:: my_module
:members:
:private-members:
:show-inheritance:
Когда я собираю документацию, я получаю HTML-файл с фрагментом, который выглядит следующим образом:
mymodule.foobar.foobar = 'Some absurdly long and ugly regex here'
Extra documentation here
mymodule.myfunc(val='Some absurdly long and ugly regex here')
blah blah blah
Основываясь на этомсообщение stackoverflowЯ думал, что смогу изменить его, изменив мой модуль на:
#!/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
... но это не сработало, а просто добавило подпись, которую я хотел под уродливой, как часть тела. Кто-нибудь знает, как я могу правильно это переопределить?
(I'm using Sphinx v1.1.3, btw.)