autodoc sphinx: как ссылаться на классы в одном модуле?

Я пытаюсь использовать расширение sphinx autodoc и, в частности, автоматическую директиву для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу создавать внутренние ссылки на разные классы в модуле без необходимости использовать автокласс и автофункцию для каждого отдельного класса / функции в проекте. Для исходного файла, подобного этому:

# source_code.py
class A:
    """docs for A
    """
    pass

class B:
    """docs for B with 
    :ref:`internal reference to A `
    """
    pass

Я хотел бы иметь такой файл документации sphinx:

.. automodule: source_code

Какую ссылку я могу использовать для XXXX-some-reference-to-A-XXXX? Есть ли простой способ добиться этого? Заранее спасибо за помощь.

25
задан mzjn 14 October 2011 в 13:11
поделиться