Отдых рисунок: Рисунок отдых — 71 фото

Отдых Перед Выступлением, Рисунок — Oxana Zhuravleva

© 2004 Oxana Zhuravleva

• Подлинное произведение искусства Рисунок,
  • Подлинное произведение искусства

    Оригинальными произведениями искусства считаются любые работы, которые считаются аутентичными, а не копией или имитацией оригинальных работ художника. Оригинальными произведениями искусства могут быть любые виды живописи, скульптуры, перформанса или других средств массовой информации. Есть много типов оригинальных носителей. Смешанная техника включает масляные, акриловые и акварельные краски. Для картин мастерской, свидетельствующих о мастерстве, эта атрибуция должна быть более тонкой. Хотя они могут быть менее ценными по разным причинам, репродукции и копии оказали огромное влияние на наш опыт.

    Они достигают более широкой аудитории, чем оригиналы, и действуют как тонизирующее средство против коммодификации. Оригинальная работа может также относиться к первой работе, которая всегда предшествует всем остальным. Он также может относиться к прототипу или модели, на основе которой могут быть выполнены другие работы. Каждая работа очень похожа на оригинал.

  • уникальный экземпляр (OOAK)

    Уникальные произведения искусства также известны как произведения искусства «OOAK». Это значит, что каждое произведение искусства уникально и не будет никогда ни одного идентичного.

  • Ограниченный выпуск

    Производство издания закончилось. Количество произведенных копий определено и указано в описании работы.

  • Открытое издание (Open Edition)

    Создание издания не завершено. Производство новых работ продолжается. Работы могут быть пронумерованы, это также включает работы на заказ и печать на заказ.

  • Неизвестное издание

    Неизвестно, сколько копий было выпущено после окончания тиража.

• Размеры Размеры доступны по запросу

Девушка-циркачка по поводу данного произведения: классификация, методы & стили рисунок рисунок — это техника визуального изображения на плоской опоре. термин «рисование» обозначает как[…]

Девушка-циркачка

Подписаться

Oxana Zhuravleva

Россия

Отдых у реки: карандашный рисунок в рамке

Автор примера Richard Turner.

Пример выполнен с помощью программ AKVIS Sketch и

AKVIS ArtSuite.

 

«Печально в гамаке она качалась, лелея мысль, чтоб лето не кончалось», – молвил бы поэт, глядя на эту трогательную картину. Richard Turner улучил момент и запечатлел свою жену во время отдыха у реки. После обработки в AKVIS Sketch и AKVIS ArtSuite обычная фотография приобрела художественный вид, а рамка придала ей законченность. Вы можете узнать, как это было сделано, из следующего описания:

• Шаг 1. Запустить программу AKVIS Sketch и открыть в ней исходное изображение.

  Фотография женщины, отдыхающей у реки

• Шаг 2. Отрегулировать параметры штриховки и запустить обработку изображения. Фотография будет конвертирована в цветной рисунок.
  Настройки для AKVIS Sketch были подобраны так:

  Чек-бокс Цветные штрихи активен;
  Угол = 45;
  Размер штрихов = 8;
  Минимальный размер штриха = 5;
  Максимальный размер штриха = 20;
  Интенсивность светлых штрихов = 8;
  Штриховка в светлом = 100.

  Результат конвертации в цветной рисунок

• Шаг 3. Сохранить полученный рисунок и выйти из программы AKVIS Sketch.
• Шаг 4. Запустить программу AKVIS ArtSuite и открыть обработанное изображение, чтобы подобрать к нему рамку.

  Удобнее делать это в режиме Автозапуска, когда любое изменение настроек рамки автоматически отражается на экране.
• Шаг 5. В выпадающем списке на Панели настроек выбрать Рамки. В соседнем выпадающем меню можно увидеть перечень рамок. Параметры выбранной рамки будут показаны ниже. Автор остановил свой выбор на рамке Штрихи.

  Подбор рамки в программе AKVIS ArtSuite

• Шаг 6. Выполнить настройку параметров выбранной рамки. Руководствуясь собственным вкусом, Richard Turner изменил такие параметры:

  Цвет рамки — серый;
  Ширина рамки = 47%;
  Толщинa штрихов = 3;
  Количество штрихов = 30.

• Шаг 7. Сохранить изображение с рамкой.
  При сохранении программа спросит, продолжить ли редактирование данного файла. Выберите «Да».

  Рисунок с рамкой

• Шаг 8. Подобрать внешнюю рамку из выпадающего списка рамок. Пусть это будет обычная Классическая рамка. Стиль классической рамки можно выбрать в миниатюрных образцах. Можно также менять яркость и ширину рамки. Ниже представлены различные варианты оформления.

  Варианты оформления

  В конце концов, автор примера остановил свой выбор на следующей рамке:

  Результат

• Шаг 9. Сохранить изображение и выйти из программы AKVIS ArtSuite.

 

ArtSuite v. 19.6 — Попробовать бесплатно   

 

reStructuredText Primer — документация Sphinx

reStructuredText — язык разметки открытого текста по умолчанию, используемый Sphinx.

Этот раздел представляет собой краткое введение в концепции и синтаксис reStructuredText (reST), предназначен для предоставления авторам достаточной информации для создания документов продуктивно. Поскольку reST был разработан как простая, ненавязчивая разметка язык, это не займет много времени.

См. также

Официальная пользовательская документация reStructuredText. Ссылки «ref» в этом ссылка на документ с описанием отдельных конструкций в reST ссылка.

Пункты

Абзац (ссылка) является самым основным блоком в REST документ. Абзацы — это просто фрагменты текста, разделенные одним или несколькими пробелами. линии. Как и в Python, в reST важны отступы, поэтому все строки один и тот же абзац должен быть выровнен по левому краю с одинаковым уровнем отступа.

Встроенная разметка

Стандартная встроенная разметка reST довольно проста: используйте

.

• одна звездочка: *текст* для выделения (курсив),

• две звездочки: **текст** для выделения жирным шрифтом и

• обратные кавычки: ``текст`` ​​ для примеров кода.

Если в бегущем тексте появляются звездочки или обратные кавычки, которые можно спутать с встроенные разделители разметки, они должны быть экранированы обратной косой чертой.

Помните о некоторых ограничениях этой разметки:

• не может быть вложенным,

• содержимое не может начинаться или заканчиваться пробелом: * текст* неверно,

• он должен быть отделен от окружающего текста несловными символами. Использовать обратная косая черта экранировала пробел, чтобы обойти это:

  thisis\ *one*\ word .

Эти ограничения могут быть сняты в будущих версиях docutils.

Также можно заменить или расширить часть этой встроенной разметки с помощью роли. Дополнительные сведения см. в разделе Роли.

Списки и блоки, подобные котировкам

Разметка списка (ссылка) естественна: просто поместите звездочку в начало абзаца и правильный отступ. То же самое и с номером списки; они также могут быть автоматически пронумерованы с помощью # знак:

 * Это маркированный список. 
* Имеет два предмета, второй
  элемент использует две строки.
1. Это пронумерованный список.
2. В нем тоже два предмета.
#. Это нумерованный список.
#. Там тоже два предмета.
 

Вложенные списки возможны, но имейте в виду, что они должны быть отделены от элементы родительского списка по пустым строкам:

 * это
* список
  * с вложенным списком
  * и некоторые подпункты
* и здесь продолжается родительский список
 

Списки определений (ref) создаются следующим образом:

 срок (до строки текста)
   Определение термина, который должен иметь отступ
   и даже может состоять из нескольких абзацев
следующий семестр
   Описание.
 

Обратите внимание, что термин не может содержать более одной строки текста.

Абзацы в кавычках (ссылка) создаются простым отступом их больше, чем окружающие абзацы.

Блоки строк (ссылка) позволяют сохранить разрывы строк:

 | Эти строки
| сломан точно так же, как в
| исходный файл.
 

Также доступны еще несколько специальных блоков:

• списки полей (ссылка, с предостережениями, отмеченными в Списки полей)

• списки опций (ссылка)

• литеральные блоки в кавычках (ref)

• блоки doctest (ссылка)

Блоки букв

Блоки литерального кода (ссылка) вводятся путем окончания абзац специальным маркером ::. Буквенный блок должен иметь отступ (и, как и все абзацы, отделенные от окружающих пробелом строки):

 Это обычный абзац текста. Следующий абзац — пример кода::
   Никак не обрабатывается, кроме
   что вмятина удалена.
   Он может охватывать несколько строк.
Это снова обычный текстовый абзац.
 

Умное обращение с маркером :: :

• Если он встречается как отдельный абзац, этот абзац полностью опускается документа.

• Если ему предшествует пробел, маркер удаляется.

• Если ему предшествует непробельный символ, маркер заменяется одним двоеточие.

Таким образом, второе предложение в первом абзаце приведенного выше примера будет отображается как «Следующий абзац — пример кода:».

Подсветка кода может быть включена для этих литеральных блоков во всем документе. на основе директивы Highlight и на основе всего проекта используя параметр конфигурации highlight_language . 9Директива 0019 code-block может использоваться для установки выделения на поблочной основе. Эти директивы обсуждаются позже.

Блоки Doctest

блока Doctest (ссылка) — это интерактивные сеансы Python. вырезаны и вставлены в строки документации. Они не требуют синтаксис литеральных блоков. Блок doctest должен заканчиваться с пустой строкой и должен ли , а не заканчиваться неиспользуемой подсказкой:

 >>> 1 + 1
2
 

Таблицы

Для растровых столов (ref), вы должны «раскрасить» ячейку сетка сама. Выглядят они так:

 +------------------------+-------------+---------- +----------+
| Строка заголовка, столбец 1 | Заголовок 2 | Заголовок 3 | Заголовок 4 |
| (строки заголовков необязательны) | | | |
+=======================+============+==========+ ==========+
| строка тела 1, столбец 1 | столбец 2 | столбец 3 | столбец 4 |
+------------------------+--------------+----------+ ----------+
| основной ряд 2 | . .. | ... | |
+------------------------+--------------+----------+ ----------+
 

Простые таблицы (ref) писать легче, но ограничено: они должны содержать более одной строки, а ячейки первого столбца не могут содержать несколько строк. Выглядят они так:

 ===== ===== =======
А Б А и Б
===== ===== =======
Ложь Ложь Ложь
Верно Ложно Ложно
Ложно Верно Ложно
Правда Правда Правда
===== ===== =======
 

Поддерживаются еще два синтаксиса: Таблицы CSV и Таблицы списка . Они используют блок явной разметки . См. Таблицы для получения дополнительной информации.

Гиперссылки

Внешние ссылки

Используйте `Текст ссылки `_ для встроенных веб-ссылок. Если текст ссылки должен быть веб-адресом, вам вообще не нужна специальная разметка, парсер находит ссылки и почтовые адреса в обычном тексте.

Важно

Между текстом ссылки и открывающим < для URL-адреса должен быть пробел.

Вы также можете разделить ссылку и целевое определение (ref), например:

 Это абзац, содержащий `ссылку`_.
.. _ссылка: https://domain.invalid/
 

Внутренние ссылки

Внутреннее связывание выполняется с помощью специальной роли reST, предоставляемой Sphinx, см. раздел о специальной разметке, перекрестные ссылки на произвольные местоположения.

Секции

Заголовки разделов (ссылка) создаются путем подчеркивания (и необязательно с подчёркиванием) название раздела со знаком пунктуации, по крайней мере пока текст:

 =================
это заголовок
=================
 

Обычно уровни заголовков не назначаются определенным символам в качестве структура определяется последовательностью заголовков. Однако это соглашение используется в Руководстве по стилю Python для документирования, которое вы можете Следуйте:

• # с надрезом, для деталей

• * с чертой, для разделов

• = для секций

• - для подразделов 9 для подразделов

• " для пунктов

Конечно, вы можете использовать свои собственные маркеры (см. документации) и использовать более глубокий уровень вложенности, но имейте в виду, что большинство целевые форматы (HTML, LaTeX) имеют ограниченную поддерживаемую глубину вложенности.

Списки полей

Списки полей (ссылка) представляют собой последовательности полей, размеченных как это:

 :fieldname: Содержимое поля
 

Они обычно используются в документации Python:

 определение my_function (my_arg, my_other_arg):
    """Функция только для меня.
    :param my_arg: Первый из моих аргументов.
    :param my_other_arg: Второй из моих аргументов.
    :returns: Сообщение (только для меня, конечно).
    """
 

Sphinx расширяет стандартное поведение docutils и перехватывает указанные списки полей в начале документов. Дополнительные сведения см. в списках полей. Информация.

ролей

Роль или «пользовательская интерпретируемая текстовая роль» (ссылка) является встроенной часть явной разметки. Это означает, что вложенный текст должен быть интерпретируется определенным образом. Sphinx использует это для обеспечения семантической разметки и перекрестные ссылки идентификаторов, как описано в соответствующем разделе. общий синтаксис :rolename:`content` .

Docutils поддерживает следующие роли:

• ударение – эквивалент *выделение*

• сильный – эквивалент **сильный**

• литерал – эквивалент ``литерал``

• нижний индекс – текст нижнего индекса

• верхний индекс – текст верхнего индекса

• title-reference – для названий книг, периодических изданий и др. материалы

См. Роли, добавленные Sphinx.

Явная разметка

«Явная разметка» (ref) используется в reST для большинство конструкций, требующих специальной обработки, таких как сноски, специально выделенные параграфы, комментарии и общие директивы.

Блок явной разметки начинается со строки, начинающейся с . . , за которой следует пробел и завершается следующим абзацем на том же уровне отступ. (Должна быть пустая строка между явной разметкой и нормальные абзацы. Все это может показаться немного сложным, но это интуитивно понятно достаточно, когда вы это пишете.)

Директивы

Директива (ref) — это общий блок явной разметки. Наряду с ролями это один из механизмов расширения reST и Sphinx. интенсивно использует его.

Docutils поддерживает следующие директивы:

• Предупреждения: внимание, осторожность, опасность, ошибка, подсказка, важное, примечание, совет, предупреждение и общий замечание. (Большинство тем оформляют только «примечание» и специально «предупреждение».)

• Изображения:

• Дополнительные элементы кузова:

  • содержимое (локальное, т.е. для текущего файла только оглавление)

  • контейнер (контейнер с пользовательским классом, полезный для создания внешний

    в HTML)

  • рубрика (заголовок без привязки к разделу документа)

  • тема, боковая панель (специально выделенные элементы тела)

  • parsed-literal (литеральный блок, поддерживающий встроенную разметку)

  • эпиграф (цитата с необязательной строкой авторства)

  • основные моменты, кавычки (блочные кавычки с их собственными атрибут класса)

  • составной (составной параграф)

• Специальные столы:

  • таблица (таблица с заголовком)

  • csv-таблица (таблица, созданная из значений, разделенных запятыми)

  • таблица-список (таблица, созданная из списка списков)

• Специальные директивы:

  • необработанный (включая необработанную разметку целевого формата)

  • include (включить reStructuredText из другого файла) — в Sphinx, когда задан абсолютный путь к включаемому файлу, эта директива принимает его как относительно исходного каталога

  • класс (назначить атрибут класса следующему элементу)

    Примечание

    Если домен по умолчанию содержит директиву класса , эта директива будет затенен. Поэтому Sphinx реэкспортирует его как первый класс .

• Особенности HTML:

  • мета (генерация тегов HTML , см. также метаданные HTML ниже)

  • название (переопределить название документа)

• Влияющая наценка:

  Так как это только для каждого файла, лучше использовать возможности Sphinx для установки роль_по умолчанию .

Предупреждение

Делать Не используйте директивы sectnum, header и нижний колонтитул.

Директивы, добавленные Sphinx, описаны в Директивах.

По сути, директива состоит из имени, аргументов, опций и содержимого. (Запомните эту терминологию, она используется в следующей главе, описывающей пользовательские директивы.) Глядя на этот пример,

 .. функция:: foo(x)
              фу(у, г)
   :module: некоторый.module.name
   Возвращает строку ввода текста от пользователя. 
 

функция — это имя директивы. Здесь приведены два аргумента: остаток первой строки и второй строки, а также один вариант модуль (как видите варианты даны в строках сразу следующие за аргументами и отмеченные двоеточиями). Опции должны быть с отступом на том же уровне, что и директивное содержание.

Содержимое директивы следует после пустой строки и имеет отступ относительно начало директивы или, если присутствуют параметры, на ту же величину, что и опции.

Будьте осторожны, так как отступ не является фиксированным количеством пробелов, например. три, но любое количество пробелов. Это может удивить, когда используется фиксированный отступ. по всему документу и может иметь значение для директив, которые чувствителен к пробелам. Сравните:

 .. кодовый блок::
   :caption: Классный пример
       Вывод этой строки начинается с четырех пробелов.
.. кодовый блок::
       Вывод этой строки не имеет пробелов в начале.
 

В первом блоке кода отступ для содержимого был зафиксирован опцией строку до трех пробелов, следовательно, содержимое начинается с четырех пробелов. В последнем отступ был зафиксирован самим содержанием в семь пробелов, таким образом он не начинается с пробела.

Изображения

reST поддерживает директиву изображения (ref), используемую следующим образом:

 .. изображение::gnu.png
   (опции)
 

При использовании в Sphinx указанное имя файла (здесь gnu.png ) должно быть относительно исходного файла или абсолютные, что означает, что они относятся к верхний исходный каталог. Например, файл sketch/spam.rst может обращаться к изображению images/spam.png как ../images/spam.png или /images/spam.png .

Sphinx автоматически копирует файлы изображений в подкаталог вывода каталог по зданию (например, _static каталог для вывода HTML.)

Интерпретация параметров размера изображения ( ширина и высота ) выглядит следующим образом: если размер не имеет единицы измерения или единицей измерения являются пиксели, заданный размер будет только соблюдается для выходных каналов, поддерживающих пиксели. Другие единицы (например, pt для точек) будет использоваться для вывода HTML и LaTeX (последний заменяет pt на bp , так как это единица TeX, такая, что 72bp=1in ).

Sphinx расширяет стандартное поведение docutils, позволяя использовать звездочку для расширение:

 .. изображение:: gnu.*
 

Затем

Sphinx ищет все изображения, соответствующие предоставленному шаблону, и определяет их тип. Затем каждый строитель выбирает лучшее изображение из этих кандидаты. Например, если было задано имя файла gnu.* и два файла gnu.pdf и gnu.png существовали в исходном дереве, LaTeX строитель выберет первое, в то время как строитель HTML предпочтет последний. Поддерживаемые типы изображений и приоритет выбора определяются на Строители.

Обратите внимание, что имена файлов изображений не должны содержать пробелов.

Изменено в версии 0.4: Добавлена ​​поддержка имен файлов, оканчивающихся звездочкой.

Изменено в версии 0.6: Пути к изображениям теперь могут быть абсолютными.

Изменено в версии 1.5: цель латекса поддерживает пиксели (по умолчанию 96px=1in ).

Сноски

Для сносок (ref) используйте [#name]_ , чтобы отметить сноску месте и добавьте тело сноски внизу документа после Заголовок рубрики «Сноски», например:

 Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_
.. рубрика:: Сноски
.. [#f1] Текст первой сноски.
.. [#f2] Текст второй сноски.
 

Вы также можете явно нумеровать сноски ( [1]_ ) или использовать автоматическую нумерацию сноски без имен ( [#]_ ).

Цитаты

Поддерживаются стандартные ссылки reST (ссылка), с дополнительная особенность в том, что они являются «глобальными», т. е. на все цитаты можно ссылаться из всех файлов. Используйте их так:

 Lorem ipsum [Ref]_ dolor sit amet.
.. [Ref] Ссылка на книгу или статью, URL или что-то еще. 
 

Использование цитирования похоже на использование сносок, но с меткой, которая не числовой или начинается с # .

Замены

reST поддерживает «замены» (ссылка), которые фрагменты текста и/или разметки, на которые в тексте ссылается |name| . Они определяются как сноски с явными блоками разметки, например:

 .. |имя| replace:: замена *текст*
 

или это:

 .. |внимание| изображение:: предупреждение.png
             :alt: Внимание!
 

См. справочник reST для замен для деталей.

Если вы хотите использовать некоторые замены для всех документов, поместите их в rst_prolog или rst_epilog или поместите их в отдельный файл и включите его во все документы, в которых вы хотите их использовать, используя включает директиву . (Обязательно дайте включаемому файлу имя файла расширение, отличающееся от расширения других исходных файлов, чтобы Sphinx не нашел его как самостоятельный документ. )

Sphinx определяет некоторые замены по умолчанию, см. Замены.

Метаданные HTML

Директива meta (ссылка) позволяет указать HTML элемент метаданных страницы документации Sphinx. Например, директива:

 .. мета::
   :description: Конструктор документации Sphinx
   :keywords: Sphinx, документация, конструктор
 

будет генерировать следующий вывод HTML:

Кроме того, Sphinx добавит ключевые слова, указанные в мета-директиве, в индекс поиска. Таким образом, атрибут lang метаэлемента считается. Например, директива:

 .. мета::
   :ключевые слова: резервное копирование
   :keywords lang=en: пожалуйста, найдите этот ключ, пожалуйста, найдите этот ключ тоже
   :keywords lang=de: bittediesenkeyfinden
 

добавляет следующие слова в поисковые индексы сборок с другим языком конфигурации:

• пожалуйста, найдите этот ключ , пожалуйста, найдите этот ключ тоже от до Английский сборок;

• bittediesenkeyfinden — Немецкий сборок;

• резервная копия для сборок на всех языках.

Исходная кодировка

Так как самый простой способ включить специальные символы, такие как длинные тире или авторские права знаков в reST заключается в том, чтобы напрямую записывать их как символы Unicode, нужно указать кодировку. Sphinx предполагает, что исходные файлы должны быть закодированы в UTF-8 дефолт; вы можете изменить это с помощью source_encoding Значение конфигурации.

Попался

Есть несколько проблем, с которыми обычно приходится сталкиваться при создании reST-документов:

• Разделение встроенной разметки: Как сказано выше, интервалы встроенной разметки должны быть отделены от окружающего текста символами, отличными от слов, вы должны использовать пробел с обратной косой чертой, чтобы обойти это. Подробности смотрите в ссылке.

• Нет вложенной встроенной разметки: Что-то вроде *см. :func:`foo`* не является возможный.

Роли — документация Sphinx

Sphinx использует роли интерпретируемого текста для вставки семантической разметки в документы. Они записываются как :rolename:`content` .

Примечание

Роль по умолчанию ( `content` ) по умолчанию не имеет специального значения. Ты бесплатно использовать его для чего угодно, например. имена переменных; использовать default_role значение конфигурации, чтобы установить известную роль — любая роль , чтобы найти что-либо, или роль py:obj , чтобы найти Объекты Python очень полезны для этого.

См. Домены для ролей, добавляемых доменами.

Синтаксис перекрестных ссылок

Перекрестные ссылки генерируются многими семантическими интерпретируемыми текстовыми ролями. По сути, вам нужно всего лишь написать :role:`target` , и ссылка будет создан для элемента с именем цель типа, указанного ролью . ссылка текст будет таким же, как цель .

Однако есть некоторые дополнительные средства, которые делают перекрестные ссылки роли более универсальны:

• Вы можете указать явное название и цель ссылки, как в reST direct гиперссылки: :role:`title ` будет ссылаться на target , но ссылка текст будет заголовок .

• Если добавить к содержимому префикс ! , ссылка/гиперссылка создаваться не будут.

• Если вы укажете содержимое префиксом ~ , текст ссылки будет только последним компонент цели. Например, :py:meth:`~Queue.Queue.get` будет обратитесь к Queue.Queue.get , но отображайте только get в качестве текста ссылки. Этот работает не со всеми ролями перекрестных ссылок, но зависит от домена.

  В выводе HTML атрибут title ссылки (который, например, отображается как всплывающая подсказка при наведении мыши) всегда будет полным именем цели.

Перекрестные ссылки на что-либо

: любой:

Новое в версии 1.3.

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

• Во-первых, он пробует стандартные цели перекрестных ссылок, на которые можно ссылаться по doc , ref или вариант .

  Пользовательские объекты, добавленные в стандартный домен расширениями (см. Сфинкс.add_object_type() ) также ищутся.

• Затем он ищет объекты (цели) во всех загруженных доменах. Это зависит от домены, насколько конкретным должно быть совпадение. Например, в Питоне домена ссылка :any:`Builder` будет соответствовать sphinx.builders.Builder класс.

Если не найдено ни одной цели или несколько целей, будет выдано предупреждение. в В случае нескольких целей вы можете изменить «любой» на определенную роль.

Эта роль является хорошим кандидатом для настройки роль_по умолчанию . если ты сделать, вы можете писать перекрестные ссылки без больших накладных расходов на разметку. За например, в этой документации по функциям Python

 .. функция:: установить()
   Эта функция устанавливает «обработчик» для каждого сигнала, известного
   «сигнальный» модуль. См. раздел «о сигналах» для получения дополнительной информации. 
 

могут быть ссылки на термин глоссария (обычно :term:`handler` ), a Модуль Python (обычно :py:mod:`signal` или :mod:`signal` ) и раздел (обычно :ref:`about-signals` ).

Роль any также работает вместе с Расширение intersphinx : когда нет локальной перекрестной ссылки найдены, все типы объектов инвентаря интерсфинкса также обыскиваются.

Объекты перекрестных ссылок

Эти роли описаны с соответствующими доменами:

• Питон

• С

• С++

• JavaScript

• РЕСТ

Перекрестные ссылки на произвольные местоположения

: ссылка:

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

• Если вы поместите метку непосредственно перед заголовком раздела, вы можете сослаться на это с :ref:`имя-метки` . Например:

   .. _my-reference-label:
  Раздел для перекрестной ссылки
  --------------------------
  Это текст раздела.
  Он ссылается на сам раздел, см. :ref:`my-reference-label`.
   

  Затем роль :ref: создаст ссылку на раздел с заголовок ссылки «Раздел для перекрестной ссылки». Это работает так же хорошо когда раздел и ссылка находятся в разных исходных файлах.

  Автоматические этикетки также работают с цифрами. Например:

   .. _моя-цифра:
  .. фигура:: что угодно
     Подписи к рисунку
   

  В этом случае ссылка :ref:`my-figure` будет вставлять ссылку к рисунку с текстом ссылки «Подпись к рисунку».

  То же самое работает для таблиц, которым задан явный заголовок с помощью директива таблицы.

• На метки, которые не помещены перед заголовком раздела, можно ссылаться, но вы должны дать ссылке явный заголовок, используя следующий синтаксис: :ref:`Заголовок ссылки <имя-метки>` .

Примечание

Метки ссылок должны начинаться со знака подчеркивания. При ссылке на ярлык подчеркивание должно быть опущено (см. примеры выше).

Использование ref рекомендуется вместо стандартных ссылок reStructuredText на разделов (например, `Название раздела`_ ), потому что он работает с файлами, когда заголовки разделов изменены, будут выдаваться предупреждения, если они неверны, и работает для всех компоновщиков, поддерживающих перекрестные ссылки.

Документы с перекрестными ссылками

Новое в версии 0.6.

Существует также способ прямой ссылки на документы:

:док:

Ссылка на указанный документ; имя документа может быть указано в абсолютная или относительная мода. Например, если ссылка :doc:`parrot` встречается в документе скетчи/индекс , затем ссылка относится к эскизам/попугаю . Если ссылка :doc:`/people` или :doc:`. ./people` , ссылка относится к человек .

Если не указан явный текст ссылки (как обычно: :doc:`Участники Monty Python ` ), заголовок ссылки будет заголовком данного документа.

Ссылки на загружаемые файлы

Новое в версии 0.6.

:скачать:

Эта роль позволяет вам ссылаться на файлы в вашем исходном дереве, которые не являются reST документы, которые можно просмотреть, но файлы, которые можно скачать.

При использовании этой роли указанный файл автоматически помечается для включение в вывод при сборке (очевидно, только для вывода HTML). Все загружаемые файлы помещаются в папку _downloads/<уникальный хеш>/ подкаталог выходного каталога; повторяющиеся имена файлов обрабатываются.

Пример:

 См. :download:`этот пример скрипта <../example.py>`.
 

Данное имя файла обычно относится к каталогу, в котором находится текущий источник файл содержится в , но если он абсолютный (начиная с / ), то он берется относительно верхнего исходного каталога.

Файл example.py будет скопирован в выходной каталог, а на него сгенерирована подходящая ссылка.

Чтобы не отображать недоступные ссылки для скачивания, следует переносить целые абзацы, которые есть эта роль:

 .. только :: builder_html
   См. :download:`этот пример скрипта <../example.py>`.
 

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

Новое в версии 1.3.

Изменено в версии 1.5: numref роль также может ссылаться на разделы. А numref позволяет использовать {имя} для текста ссылки.

:число:

Ссылка на указанные рисунки, таблицы, кодовые блоки и разделы; стандарт Используются reST-метки. Когда вы используете эту роль, она будет вставлять ссылку на рисунок с текстом ссылки по номеру рисунка, например «Рис. 1,1”.

Если указан явный текст ссылки (как обычно: :numref:`Изображение Сфинкса (рис. %s) ` ), заголовок ссылки будет служить заголовком ссылки. В качестве заполнителей %s и {число} заменяются цифрой. число и {имя} по подписи к рисунку. Если явный текст ссылки не указан, используется параметр numfig_format . используется как запасной вариант по умолчанию.

Если numfig равно False , цифры не нумеруются, поэтому эта роль вставляет не ссылку, а метку или текст ссылки.

Перекрестные ссылки на другие интересующие вопросы

Следующие роли, возможно, создают перекрестную ссылку, но не относятся к объектов:

:envvar:

Переменная среды. Создаются индексные записи. Также генерирует ссылку к соответствующей директиве envvar , если она существует.

:токен:

Имя лексемы грамматики (используется для создания ссылок между производственный список директив).

:ключевое слово:

Имя ключевого слова в Python. Это создает ссылку на ссылочную метку с этим именем, если оно существует.

: вариант:

Параметр командной строки для исполняемой программы. Это создает ссылку на директива option , если она существует.

Следующая роль создает перекрестную ссылку на термин в глоссарий:

: срок:

Ссылка на термин в глоссарии. Глоссарий создается с помощью глоссарий директива, содержащая список определений с терминами и определения. Он не обязательно должен находиться в том же файле, что и срок наценка, например, документы Python имеют один глобальный глоссарий в glossary.rst файл.

Если вы используете термин, который не объяснен в глоссарии, вы получите предупреждение во время сборки.

Подсветка встроенного кода

: код:

Пример встроенного кода . При прямом использовании эта роль просто отображает текст без подсветки синтаксиса , как литерал.

 По умолчанию встроенный код, такой как :code:`1 + 2`, просто отображается без
выделение.
 

В отличие от директивы code-block , эта роль не учитывает язык по умолчанию, установленный директивой highlight .

Чтобы включить подсветку синтаксиса, вы должны сначала использовать роль Docutils директива для определения пользовательской роли, связанной с определенным языком:

 .. роль :: питон (код)
   :язык: питон
В Python :python:`1 + 2` равно :python:`3`.
 

Чтобы отобразить пример многострочного кода, используйте директиву code-block . вместо. 92`.

экв:

То же, что и math:numref .

Другая семантическая разметка

Следующие роли не делают ничего особенного, кроме форматирования текста в другой стиль:

:сокращение:

Аббревиатура. Если содержание роли содержит объяснение в скобках, он будет обработан особым образом: он будет показан во всплывающей подсказке в HTML, а выводить только один раз в LaTeX.

Пример: :abbr:`LIFO (последний вошел, первый ушел)` .

Новое в версии 0.6.

: команда:

Имя команды уровня ОС, например rm .

:dfn:

Пометить определяющий экземпляр термина в тексте. (Нет записей указателя сгенерировано.)

: файл:

Имя файла или каталога. В содержимом вы можете использовать фигурные фигурные скобки для обозначения «переменной» части, например:

 ... устанавливается в :file:`/usr/lib/python3.{x}/site-packages` ...
 

В встроенной документации x будет отображаться иначе, чем указать, что он должен быть заменен минорной версией Python.

:гуилабель:

Этикетки, представленные как часть интерактивного пользовательского интерфейса, должны быть помечены используя гилейбел . Сюда входят метки из текстовых интерфейсов, таких как созданные с использованием curses или другие текстовые библиотеки. Любой ярлык используемые в интерфейсе должны быть отмечены этой ролью, включая кнопку метки, заголовки окон, имена полей, меню и названия пунктов меню и даже значения в списках выбора.

Изменено в версии 1.0: Клавиша быстрого доступа для метки GUI может быть включена с использованием амперсанда; это будет удалено и отображено подчеркнутым в выводе (пример: :guilabel:`&Cancel` ). Чтобы включить буквальный амперсанд, удвойте его.

:кбд:

Отметить последовательность нажатий клавиш. Какую форму принимает ключевая последовательность, может зависеть на соглашениях, специфичных для платформы или приложения. Когда нет соответствующих соглашениях, имена клавиш-модификаторов должны быть прописаны, чтобы улучшить доступность для новых пользователей и не носителей языка. Например, последовательность клавиш xemacs может быть помечена как :kbd:`C-x C-f` , но без ссылка на конкретное приложение или платформу, такая же последовательность должна быть отмечен как :kbd:`Control-x Control-f` .

Имя почтового заголовка в стиле RFC 822. Эта разметка не означает, что заголовок используется в сообщении электронной почты, но может использоваться для ссылки на любой заголовок того же «стиля». Это также используется для заголовков, определенных различные спецификации MIME. Имя заголовка должно быть введено в поле так же, как это обычно встречается на практике, с верблюжьей оболочкой соглашения предпочтительнее, когда существует более одного общего использования. За пример: :mailheader:`Content-Type` .

:макевар:

Имя сделать переменной.

:страница руководства:

Ссылка на страницу руководства Unix, включая раздел, например. :manpage:`ls(1)` . Создает гиперссылку на внешний сайт, отображающий man-страница, если определено manpages_url .

Пункты меню должны быть отмечены с помощью выбор меню роль. Это используется для обозначения полной последовательности пунктов меню, включая выбор подменю и выбор конкретной операции или любой последовательности такой последовательность. Названия отдельных вариантов должны быть разделены --> .

Например, чтобы отметить пункт «Пуск > Программы», используйте следующую разметку:

 :menuselection:`Пуск --> Программы`
 

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

menuselection также поддерживает акселераторы амперсанд, как гилейбел .

:миметип:

Имя типа MIME или компонента типа MIME (основной или второстепенный порция, взятая отдельно).

:группа новостей:

Название группы новостей Usenet.

Todo

Разве это не часть стандартного домена?

:программа:

Имя исполняемой программы. Это может отличаться от имени файла для исполняемый файл для некоторых платформ. В частности, .exe (или другой) следует опускать для программ Windows.

:регулярное выражение:

Регулярное выражение. Цитаты не должны быть включены.

:самп:

Часть обычного текста, например код. В содержимом вы можете использовать фигурные скобки для обозначения «переменной» части, как в файл . За например, в :samp:`print 1+{variable}` часть переменная будет подчеркнул.

Если вам не нужна индикация «переменная часть», используйте стандартную код вместо роли .

Изменено в версии 1.8: разрешено экранировать фигурные скобки с обратной косой чертой

Существует также роль index для создания записей индекса.

Следующие роли генерируют внешние ссылки:

:пеп:

Ссылка на предложение по улучшению Python. Это порождает соответствующие индексные записи. Генерируется текст «PEP номер »; в выводе HTML, этот текст является гиперссылкой на онлайн-копию указанного PEP. Вы можете ссылку на определенный раздел, сказав :pep:`number#anchor` .

:rfc:

Ссылка на интернет-запрос комментариев. Это порождает соответствующие индексные записи. Текст «RFC номер «генерируется; в выводе HTML, этот текст является гиперссылкой на онлайн-копию указанного RFC. Вы можете ссылку на определенный раздел, сказав :rfc:`number#anchor` .

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

Замены

Система документации предоставляет три замены, которые определены дефолт.