В документации Sphinx возможно ли использовать имя модуля для указания образца кода, который будет включен?

Question

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

То есть вместо того, чтобы делать то, что указано здесь Показаны примеры кода

.. literalinclude example.py

или

.. literalinclude ../../example.py

Я бы лучше сделал (например)

.. includemodule mymodule.example

Можно ли обойтись без написания собственного расширения? Или как проще написать такое расширение?

Answer 1

Вы можете ссылаться на другие классы, используя что-то вроде этого:

:class:`~module.submodule.Class`

Если вы добавляете примеры в класс как doctest, у вас есть примеры, которые гарантированно будут работать, так как они запускаются напрямую.