Сохранение встроенного кода внутри ссылок в Sphinx - PullRequest
Новая
       61

Сохранение встроенного кода внутри ссылок в Sphinx

35 голосов
/ 11 ноября 2011

В Сфинксе, если у меня есть следующее объявление заголовка: 

.. _somestuff:

``this is code``, this is not!
==============================

Это выглядит так:

this is code, это не так!

Это хорошо, но, если я использую ссылку, например: 

Have a look at :ref:`somestuff`

Он теряет форматирование кода и отображает как:

Взгляните на это код, это не так

вместо:

Посмотрите на this is code, это не так!

Можно ли сохранить форматирование кода в справочнике? И как мне это сделать?

1 Ответ

2 голосов
/ 27 марта 2014

Если вы посмотрите документацию :ref: на официальном сайте о встроенных наценках:

: исй:

Для поддержки перекрестных ссылок на произвольные места в любом документе, используются стандартные метки reST. Для этого на этикетке должны работать названия быть уникальным во всей документации ...

Я думаю (как @Kevin Horn), сейчас это невозможно, потому что он используется только для создания ссылок (без первого форматирования) с другими разделами вашего проекта. Тогда, если вы напишите что-то вроде этого: 

.. _somestuff:

``this is code``, this is not!
==============================

.. _another_somestuff:

this is another code!
========================

Если я свяжусь с этими разделами: 

Have a look at :ref:`somestuff`
Have a look at :ref:`another_somestuff`
Have a look at :ref:`this link <somestuff>`

Результат:

Посмотрите на это код, это не так

Посмотрите на это еще один код!

Посмотрите на эту ссылку

Стиль одинаков во всех них.

Примечание : курсивные / жирные слова символизируют ссылки

...