Более короткое имя для ссылки на класс в Sphinx - PullRequest
0 голосов
/ 19 сентября 2018
.. seealso::

   Class :class:`apps.business.models.Department`
      Explanation goes here

   `GNU tar manual, Basic Tar Format <http://link>`_
      Documentation for tar archive files, including GNU tar extensions.

Это создает правильную ссылку на класс отдела.

enter image description here

Как изменить вывод HTML на одно имя класса без 'apps.business.models 'префикс?

, поэтому он читает Class Department в HTML?

1 Ответ

0 голосов
/ 19 сентября 2018

Существует ~ (тильда) в стандартном синтаксисе перекрестных ссылок .

Если вы добавите префикс к ~, текст ссылки будет только последнимКомпонент цели.Например,

:py:meth:`~Queue.Queue.get`

будет ссылаться на Queue.Queue.get, но в качестве текста ссылки будет отображаться только get.Это не работает со всеми ролями перекрестных ссылок, но зависит от домена.

Существует также директива .. currentmodule:: с некоторой документацией и примером в другомТАК ответ .

...