Я использую функцию Sphinx autodoc
для создания документации на основе docstrings в моей библиотеке Python.
Синтаксис перекрестной ссылки найден здесь
Метка должна предшествовать разделу, чтобы разрешить ссылку на этот раздел из других областей документации.
У меня есть файл .rst(ReStructeredText) для одного из моих классов. Он использует
.. autoclass:: classname
:members:
Чтобы создать документацию для класса.
Мой вопрос: как бы я ссылался на автогенерированные методы класса из другого документа .rst в документации? Если я попытаюсь поместить метку в метод docstring, Sphinx жалуется. Если я попытаюсь поместить ярлык перед заголовком метода, Sphinx не распознает его.
Есть ли простой способ сделать это, или мне нужно явно записать в свой файл класса имя метода и предшествовать его с помощью метки?
Вот пример ссылки в [Документация Python 2, которая делает то, что мне нужно (я предполагаю, что она использует функцию автодока, хотя я не точно знаю)