Сфинксът употреби тълкува текстови роли, за да вмъкнете семантично маркиране до документи. Те са описани като: rolename: `content`.

подразбиране подразбиране роля ( `content`) няма особен смисъл. Можете да го използвате за нещо. Използвайте конфигурация стойност: confval: `default_role` за обвързване на добре познати роля.

Вижте домейни. който разкрива добавянето роли домени.

Синтаксис кръст ssylok¶

Има някои допълнителни функции, които дават възможност да се съпоставят по-гъвкави:

. текста на връзката ще бъде само последният компонент на целта. Например ,: пг: мет: `

Queue.Queue.get` ще се отнасят до Queue.Queue.get но както ще се покаже текста само точка.

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

Обектите, които са напречно ssylki¶

Следните роли са описани в съответните области:

Всеки режим на кръстосано ssylok¶

За да може да се позове на произволни места във всеки документ, използвайки стандартни етикети (етикети) почивка. За да може това да се работи имената на етикетите трябва да са уникални в рамките на цялата документация. Има два начина, можете да обърнете внимание на етикета:

Ако поставите маркера непосредствено преди заглавието на раздел, можете да се обърнете към него с помощта на: REF: `етикет-name`. Например:

Автоматични етикети също работят с фигури (цифри):

В този случай: Код: `ми-figure` нанесете препратка към фигурата с текста на връзката" фигури заглавие ".

Същите работи за маси с дадената титлата, той трябва да използва директива: dudir: `table`.

Етикети, че все още не се намират, които можете да използвате, преди заглавието на раздела за връзката, но в този случай трябва да зададете име на връзката с помощта на този синтаксис :: Код: `име Линк `.

Използване на код за предпочитане пред стандартни модели за раздел reStructuredText (например, `раздел title`_), като първият метод ще работи в случай на участък промени горния и работи за всички" берачи "поддържащи препратка.

Препратки към dokumenty¶

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

В допълнение към по-горе, има начин директно да се позова на документи:

Ако текстът на връзката Unknown (за разлика, например :: док: `членове на Монти Пайтън `), Тогава той ще се използва като заглавие на документа.

Връзки към сваляне fayly¶

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

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

Когато използвате тази роля, съответният файл се маркира автоматично за включване в производството, когато събранието (очевидно, това е вярно само за HTML изход). Всички изтеглени файлове се поставят в поддиректория на _downloads на изхода на каталози; дублират имена на файлове се обработват (дублиращи се имена на файлове се обработват).

Името на файла е посочено обикновено относително файл, съдържащ тази директива; но ако това е посочено в абсолютна форма (като се започне с /), а след това се счита по отношение на указателя с изходните файлове.

Кръстосаните препращания към други elementy¶

Следващите роли ви позволяват да създавате препратки, но те не се отнасят до специфични обекти:

Наименование граматика токен (граматика знак) (използване за създаване на връзки между директивите productionlist).

Име Python ключови думи. Създава линк към марката на съотнасяне с това име, ако има такъв.

опция команден ред за работеща програма. Първоначалната таблото също трябва да бъдат включени. Създава линк към опцията за директива. ако има такъв.

Следващият ролята създава препратка към термина в речника:

Ако използвате термин, който не е обяснение в речника, вие poluchete предупреждение по време на монтажа.

Друг семантичен razmetka¶

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

Съкращение. Ако съдържанието на ролята съдържа текста в скобите, това ще се счита за по специален начин: в HTML тя ще бъде показана като върха инструмент, и само един ще бъде показано в LaTeX.

Пример :: съкр: `LIFO (последната, първи навън)`.

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

ниво Наименование команди OS, като RM.

Разпознавателни в текст. (Индекс на елемента не е създаден.)

името на файла или директория. Съдържанието на ролята можете да използвате figrunye скоби за обозначаване на "променлива" част от пътя, например:

В последната документация х ще бъде показан променян само за да покаже, че трябва да има второстепенна версия брой Python.

Маркерите са част от трябва да се маркира като guilabel интерактивен потребителски интерфейс. Това включва текст и етикети интерфейси, като например тези, произведени чрез използване на проклятия и други текстови библиотеки. Всички етикети, използвани в интерфейса трябва да са маркирани с тази роля, включително бутона Етикети прозорци заглавия, имена на полета, менюта и дори ценности в списъци за избор.

Промени във версия 1.0: Клавишни комбинации за GUI етикети могат да се добавят посредством знака; получаването на това се отстранява и съответната буква ще бъде подчертано (например :: guilabel: `Cancel`). За вмъкване на амперсанд това се удвои.

Бележки поредица от натискания на клавиши. Формата на тази последователност може да зависи от платформата или прилагането. Ако някое от споразуменията, не означава, че тя трябва да бъде пълното име на клавишите за модифициращите да помогне на новите потребители и не са носители на езика. Например, удар последователност на XEmacs може да бъде определен като: KBD: `С-Х-С f`. но без позоваване на конкретно приложение / платформа същата последователност трябва да бъде описана като: KBD: `контрол х контрол f`.

Име на хедъра на електронното писмо в RFC стил 822. Това маркиране не означава, че титлата се използва в съобщение, но то може да се използва за означаване на всеки удар с глава на една и съща "стил". Той се използва и за заглавията, определени от различните MIME спецификации. Името на заглавната трябва да се въведе по същия начин, както ако тя е била използвана в предпочитано използване CamelCase (където има повече от една обща употреба). Например :: mailheader: `Content-Type`.

Име променливи правят.

опции в менюто трябва да са маркирани с помощта на роля menuselection. Той се използва за отбелязване на завършен цикъл от избора на менюто, подменюта и специфични операции. Или някой от последователности на тези последователности. Имена на индивидуалния избор трябва да бъдат отделени посредством ->.

Например, за да отбележат избора "Start> Programs", използвайте следната маркиране:

Ако включите изборите, които съдържат някои показатели в края на името, като точки, които в някои системи, означава, че елементът от менюто се отваря диалогов прозорец, тези показатели трябва да бъдат оставени на живот.

menuselection също поддържа използването на знака за по guilabel.

Име MIME тип, или MIME-тип компонент (по-възрастни или по-млади части отделно).

Име Usenet дискусионна група.

Името на изпълнима програма. Може да се различава от името на файла на някои платформи. По-специално, разширение .exe (или и двете) може да се изпусне на Windows.

Регулярният израз. на разстояние не е нужно кавички.

А част от текст или код. Съдържанието може да използвате големи скоби, за да се обозначи "променлива" част, как да се подаде. Например, в: SAMP: `отпечатване 1 +`. на променливата ще бъде осветен.

Ако не трябва да означава "променлива част", а след това използвайте standany `` code``.

В допълнение, има роля за индекса създаване на записи в индекса.

Следващите роли създават vneshine връзки:

Моля, обърнете внимание, че няма специални роли, за да добавите хипервръзки, тъй като можете да използвате стандартната оформление почивка.

Podstanovki¶

Системата за документация осигурява три замествания, които са определени по подразбиране. Те са разположени в "колектор" конфигурационния файл.

Се заменя с освобождаването на проекта, който е описан в документацията. Това трябва да бъде низ с пълната версия включително маркери алфа / бета / отделяне / кандидат, например 2.5.2b3. Се изчислява по формулата: confval: `release`.

Заменен версия на проекта, която е описана в документацията. Тя трябва да бъде низ само с голям и малък брой версия, като например 2.5, дори и за версия 2.5.1. Се изчислява по формулата: confval: `version`.