#python #python-sphinx #cross-reference
#python #python-sphinx #перекрестная ссылка
Вопрос:
Я пытаюсь использовать 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)}
Ответ №1:
:py:meth: Должно быть :py:func: . В принципе, можно использовать любой допустимый домен.
Комментарии:
1.
:py:func:работает, но следует отметить, что intersphinx сначала должен быть настроен!
Ответ №2:
Вы читали документацию для intersphinx?
Редактировать
Заставил его работать, используя это:
***
TRY
***
My try
======
sin
:py:func:`math.cos`
pop
:py:meth:`dict.pop`
dict
:py:meth:`dict.items`
zipfile
:py:class:`zipfile.ZipFile`
Прочитайте о конструкциях здесь перекрестная ссылка
Комментарии:
1. у меня тоже не работает, нашел этот интересный пост, который я сейчас читаю comments.gmane.org/gmane.comp.python. sphinx.devel/4283
2. Я обнаружил, что мне следовало использовать:py: func: вместо :py:meth: