sphinx: внутренняя короткая ссылка на класс python

Question

Как я могу достичь чего-то подобного в сфинксе?

Creates a `ClassName`_ instance. 

.. _ClassName: :class:`~very.long.path.to.ClassName` 

Я хотел бы иметь короткие ссылки на ссылки на длинный класс/методы/etc, чтобы сделать мою документацию более удобочитаемой.

Answer 1

Лучший способом я нашел до сих пор, чтобы уменьшить длину моих ссылок питона использовать текущую директиву модуля:

.. py:currentmodule:: very.long.path.to.package 

This is my :class:`~module_in_package.ClassName`. 

Answer 2

Я была такая же проблема, но я, наконец, получил то, чтобы работать с использованием reST Substitutions. Попробуйте следующее:

Creates a |ClassName| instance. 

.. |ClassName| replace:: :class:`~very.long.path.to.ClassName`