Использование Sphinx 2.2.0 и python 3.6.8
У меня есть два класса, A
и B
, и свойство A
генерирует экземпляр B
. Я хотел бы, чтобы мой вывод sphinx html ссылался на объект B
, но я бы хотел, чтобы необработанная строка документации не имела форматирования sphinx / rest. Я использую autodoc, и большинство методов и свойств в A
не требуют этой модификации, но я хотел бы сделать это в нескольких местах, если это возможно.
class A(object):
"""
This is class A.
"""
@property
def getB(self):
"""
Get an instance of B.
"""
return B()
# A also includes many other methods and properties which
# I want to document using autodoc
class B(object):
pass
Я могу написать Get an instance of :class:`<B>`.
в getB
строке документации, но тогда A.getB.__doc__
или help(A.getB)
будут содержать именно этот текст. Я бы хотел, чтобы A.getB.__doc__
остался Get an instance of B
, но имел ссылку в выводе html, созданном autodoc.
class A
Bases: object
getB
Get an instance of B̲.
Предполагая, что A находится в a.py, я пробовал
.. automodule:: a
:member: A
:exclude-member: getB
.. method:: getB
:property:
get an instance of :class:`<B>`.
Однако это не помещает B в документацию класса A или должным образом ссылается на класс B.
property a.getB
Get an instance of B.
class A
Bases: object
Я также пробовал .. method:: a.getB
и .. method:: a.A.getB
безуспешно.
За исключением попытки получить вывод autodoc и его непосредственного изменения, могу ли я каким-либо образом можно это сделать?