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