Как бы я перекрестно ссылался на функцию, сгенерированную autodoc в Sphinx?

Я использую функцию autodoc Sphinx для создания документации, основанной на docstrings моей библиотеки Python.

Синтаксис для перекрестной ссылки найден здесь

Ярлык должен предшествовать разделу, чтобы разрешить ссылку на этот раздел из других областей документации.

У меня есть файл .rst (ReStructeredText) для одного из моих классов. Оно использует

 .. autoclass:: classname :members: 

Чтобы создать документацию для этого класса.

Мой вопрос в том, как бы я ссылался на автогенерированные методы класса из другого документа .rst в документации? Если я попытаюсь поместить ярлык в docstring метода, Sphinx жалуется. Если я попытаюсь поместить метку перед заголовком метода, Sphinx не узнает ее.

Есть ли простой способ сделать это, или мне нужно явно написать в своем файле класса имя метода и предшествовать его с помощью метки?

Вот пример ссылки в [Документация Python 2, выполняющая то, что мне нужно (я предполагаю, что она использовала функцию автодока, хотя я не знаю точно)

One Solution collect form web for “Как бы я перекрестно ссылался на функцию, сгенерированную autodoc в Sphinx?”

Вам не нужно добавлять ярлыки. Чтобы обратиться к классу, методу или другому документированному объекту Python , используйте разметку, предоставляемую доменом Python .

Например, следующее определяет перекрестную ссылку на метод mymethod :

 :py:meth:`mymodule.MyClass.mymethod` 

Или даже проще (поскольку домен Python является значением по умолчанию):

 :meth:`mymodule.MyClass.mymethod` 

Документация TextWrapper.wrap которую вы TextWrapper.wrap в вопросе, включает в себя две перекрестные ссылки такого типа (нажмите «Показать источник», чтобы увидеть разметку reST).

  • атрибуты автокласса и экземпляра
  • В Sphinx есть способ документировать параметры вместе с объявлением их?
  • sphinx autodoc включают подфункции
  • Как загрузить html-документацию, сгенерированную с помощью sphinx в github?
  • Как добавить теги стиля блога в reStructuredText с Sphinx
  • Документирование с помощью методов Python Sphinx, которые имеют параметры по умолчанию с дозорными объектами?
  • Как я могу документировать элементы в определенных разделах с помощью Sphinx?
  • Python Sphinx ссылается на длинные имена
  • Python - лучший язык программирования в мире.