Inline markup - python-lahs dokumentáció

A szfinx értelmezett szöveg szerepeket használ a szemantikai jelölés beillesztésére a dokumentumokba. Ezek a következők: rolename: `content`.

Alapértelmezés szerint az alapértelmezett szerep (`content`) nincs különösebb jelentéssel. Használhatja bármi számára. Használja a konfigurációs értéket: confval: `default_role`, hogy ezt egy ismert szerephez köti.

Domainek megtekintése. ahol a doménekre vonatkozó szerepkörök felvételét írják le.

Kereszthivatkozások szintaxisa "

Vannak olyan további jellemzők is, amelyek rugalmasabbá teszik a hivatkozásokat:

. a link szövege csak a cél utolsó eleme. Például: py: meth: `

Queue.Queue.get` fog hivatkozni a Queue.Queue.get, de csak kap megjelenik a szöveg.

A HTML-kimenetben a cím linkjének attribútuma (a hivatkozás fölött lebegő mutató) mindig a cél teljes neve.

Kereszthivatkozási objektumok¶

A következő területek a megfelelő tartományokban vannak leírva:

Kereszthivatkozások bármely pozícionálása

Annak érdekében, hogy bármely dokumentum tetszőleges helyekre hivatkozzon, szabványos címkék (címkék) reST-t használnak. Annak érdekében, hogy ez a munka, a címke nevének egyedinek kell lennie a teljes dokumentációban. A címkékre kétféleképpen lehet hivatkozni:

Ha a címke közvetlenül a szakaszfejléc előtt helyez el, akkor hivatkozhat a következőre: ref: `label-name`. Például:

Az automatikus címkék számokkal is dolgoznak:

Ebben az esetben: ref: a "my-figure" linket az "Headline shape" linkre írja.

Ugyanez működik a megadott fejléccel ellátott táblák esetében, ehhez az irányelvt kell használni: dudir: `table`.

Azon címkék azonban, amelyek nem találhatók a cím címe előtt, felhasználhatók referenciákhoz, de ebben az esetben a következő szintaxissal meg kell adnia a fejlécet: ref: `Link cím `.

Használata ref kívánatos a standard referenciák reStructuredText szakasz (például `szakasz title`_), mint az első módszer működik abban az esetben, egy szakasz címet változások és működik minden„szedők”támogató kereszt-referencia.

Dokumentumok kereszthivatkozásai ¶

Új a 0.6 verzióban.

A fentiek mellett van mód a dokumentumok közvetlen hivatkozására:

Ha a hivatkozás szövege nincs megadva (ellentétben például a :: doc: `Monty Python tagokkal `), akkor a dokumentum címét fogja használni.

Linkek letöltése

Új a 0.6 verzióban.

Ez a szerep lehetővé teszi, hogy olyan fájlokra hivatkozzon, amelyek nem reST-dokumentumok, és amelyek letölthetők.

Ha ezt a szerepet használja, akkor a hivatkozott fájl automatikusan megjelölésre kerül a kibocsátásba a telepítés során (nyilvánvalóan ez csak a HTML kimenetre vonatkozik). Minden letöltött fájl a kimeneti könyvtár _downloads alkönyvtárába kerül; duplikált fájlneveket kezelnek.

A fájlnév általában az irányelvt tartalmazó fájlra vonatkozik; de ha abszolút formában van megadva (kezdődő /), akkor a forrásfájlokkal rendelkező könyvtárhoz viszonyítva tekinthető.

Kereszthivatkozások más elemekre

A következő szerepkörök lehetővé teszik a kereszthivatkozások létrehozását, de nem utalnak konkrét objektumokra:

A nyelvtani token (grammatikai token) neve (a gyártási lista irányelvek közötti kapcsolatok létrehozására használják).

A Python kulcsszó neve. Létrehozza a hivatkozott címkét erre a névre, ha létezik.

A végrehajtható program parancssori opciója. A kezdeti kötőjeleket is fel kell venni. Létrehoz egy hivatkozást az opciós irányelvre. ha létezik.

A következő szerepkörben hivatkozás található a szótár kifejezésre:

Ha olyan kifejezést használ, melynek nincs magyarázata a szótárban, figyelmeztetést kap az összeállítás során.

Más szemantikus jelölés¶

A következő szerepkörök nem teszek semmi különöset, kivéve a szöveg formázását egy bizonyos stílusban:

Rövidítése. Ha a szerep tartalma zárt zárójelben tartalmazza a szöveget, akkor speciális módon fogják kezelni. A HTML-ben eszköztippként jelenik meg, és csak egyszer jelenik meg a LaTeX-ben.

Példa :: abbr: `LIFO (utolsó-in, first-out)`.

Új a 0.6 verzióban.

Az operációs rendszer szintű parancs neve, például az rm.

Jelöli a definíciót a szövegben. (Ebben az esetben nem hoz létre index elemet.)

A fájl vagy könyvtár neve. A szerep tartalma a zárójelek segítségével jelezheti az útvonal "változó" részét, például:

A kész dokumentációban az x változott módon jelenik meg, jelezve, hogy Python kisebb változata legyen.

A címkék az interaktív felhasználói felület részét képezik a guilabel címkével. Ez magában foglalja a szöveges felületekhez tartozó címkéket, például a kurvákkal vagy más szövegkönyvtárakkal létrehozott címkéket. A felületen használt összes címkét ennek a szerepnek kell címkéznie, beleértve a gombok címkéit, az ablakok címét, a mezők nevét, a menüket és az értékeket a kiválasztási listákban.

Megváltozott az 1.0-s verzióban: A GUI-címkék gyorsbillentyűi hozzáadhatók amper; ha eltávolításra kerül, akkor törölni fog, és a megfelelő levél aláhúzandó (például :: guilabel: "Mégsem"). Az ampersand beillesztéséhez és duplázásához.

Jelzi a billentyűleütések sorrendjét. Ennek a sorrendnek a formája függhet a platformtól vagy az alkalmazástól. Ha nincsenek megállapodások, akkor meg kell adnia a módosító kulcs teljes nevét, hogy segítsen az új felhasználóknak és a nem anyanyelvi beszélőknek. Például az xemacs kulcsszekvenciáját a következőképpen lehet jelezni: kbd: `C-x C-f`. de egy adott alkalmazásra / platformra való hivatkozás nélkül ugyanazt a sorrendet kell kijelölni: kbd: Control-x Control-f.

Az e-mail fejléc neve az RFC 822 stílusában található. Ez a jelölés nem jelenti azt, hogy a címet a levélben használják, de ugyanazon "stílus" bármelyik címére hivatkozhat. Más MIME-specifikációk által meghatározott fejlécekhez is használható. A cím címét úgy kell megadni, mintha a CamelCase előnyben részesített esetben használták volna (ahol több közös használat van). Például :: mailheader: "Content-Type".

A make változók neve.

A menüválasztásokat a menüket választó szerepkörrel kell jelölni. A menüpontok, almenük és műveletek teljes sorrendjének megjelölésére szolgál. Vagy ezeknek a szekvenciáknak bármelyik sorozata. Az egyes választások nevét el kell különíteni ->.

Például a "Start> Programok" jelölés jelöléséhez használja a következő jelölést:

Ha olyan elemeket is tartalmaz, amelyek a név végén bizonyos mutatókat tartalmaznak, például az ellipszis, amely bizonyos rendszereken azt jelenti, hogy ez a menüpont párbeszédablakot nyit meg, ezeket a mutatókat el kell hagyni.

a menuselection is támogatja az olyan hangszerek használatát, mint a guilabel.

A MIME típus neve vagy a típus MIME összetevője (magas vagy alacsony).

Usenet hírcsoport neve.

A végrehajtható program neve. Néhány platformon eltérhet a fájlnévtől. Különösen a .exe (vagy más) kiterjesztés elhagyható Windows rendszeren.

Rendszeres kifejezés. Ne fordítsd az idézeteket.

Egy darab szöveg vagy kód. A tartalomban a göndör zárójelek használhatják a "változó" részt, mint a fájlban. Például: samp: `print 1 +`. a változó egy része kiemelendő.

Ha nem kell kijelölnie a "módosítható részt", akkor használja a szabványos "kódot".

Ezenkívül indexelemek vannak indexelemek létrehozásához.

Az alábbi szerepek extra szöveget hoznak létre:

Ne feledje, hogy nincs speciális szerepkör a hiperlinkek hozzáadásához, mert ehhez használhatja a szabványos REST jelölést.

Helyettesítések Под

A dokumentációs rendszer három helyettesítést tartalmaz, amelyeket alapértelmezés szerint definiálnak. Ezek a "gyűjtő" konfigurációs fájljában vannak megadva.

Cserélve a projekt kiadásával, amelyet a dokumentáció ír le. Ez egy teljes verziójú string legyen, beleértve az alfa / béta / kibocsátás / jelölt címkéket, például a 2.5.2b3-at. Megadja a következő parancsot: confval: `release`.

Cserélve a projekt verziójával, amelyet a dokumentáció ír le. Ez egy olyan karakterlánc legyen, amelynek csak egy nagyobb és kisebb verziószáma van, például 2.5, még a 2.5.1 verzióhoz is. Megadja: confval: `version`.