Как я могу поместить ссылку intersphinx на произвольный метод в документации стандартной библиотеки? - PullRequest
8 голосов
/ 25 мая 2011

Я пытаюсь использовать Sphinx для документирования проекта, но не могу понять, как его использовать intersphinx. Я использую эту строку:

:py:meth:`math.sin`

, чтобы добавить ссылку, но в выходных данных она отображается жирным шрифтом, а не как ссылка. Хотя эта строка не работает, обе следующие функции:

:py:meth:`dict.items`
:py:class:`zipfile.ZipFile`

Мое значение intersphinx_mapping в файле conf.py:

intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)}

Ответы [ 2 ]

8 голосов
/ 26 мая 2011

:py:meth: должно быть :py:func:. В принципе, можно использовать любой действительный домен .

5 голосов
/ 25 мая 2011

Вы читали документацию для intersphinx ?

Редактировать

Получил это, используя это:

***
TRY
***

My try
======

sin
:py:func:`math.cos`

pop
:py:meth:`dict.pop`

dict
:py:meth:`dict.items`

zipfile
:py:class:`zipfile.ZipFile`

Читайте о конструкциях здесь перекрестная ссылка

...