Мы перешли с Sphinx на стиль строки документации NumPy, и .. sectionauthor::
больше не кажется, визуализировать правильно. Тем не менее, нам нужно иметь возможность назначать автора каждому методу класса.
Есть ли способ правильно добавить авторство в строку документации NumPy?
Наивный пример:
class A:
def f(self):
""" My function
It does this and that.
Returns
-------
object
.. sectionauthor:: name of the author
Examples
--------
>>> A().f()
"""
pass
Компилируется в этот справочный документ (обратите внимание на проблемный раздел returns:):
P.S. Использование .. sectionauthor::
в строке документации NumPy было предложено в другом месте (не могу вспомнить источник), поэтому, возможно, оно просто неправильно используется/размещено.
docstring
. Я не знаю, есть ли уnumpy
собственный стиль или механизм рендеринга (отличный от Pythondocstring
). - person hpaulj   schedule 27.11.2015reStructuredText
, которые, вероятно, обрабатываютсяdocutils
. - person hpaulj   schedule 28.11.2015