Automaattisen paperityön ikäryhmä on poissa käytöstä

Uusin esimerkki on suunnattu Sphinx-aloittelijoille, jotka ovat https://onlinekasinolla.com/rizk-casino/ valmiita oppimaan ideoiden luomisen ja järjestämisen perusteet. Voit saada tilannekuvan omasta Git-repositoriostasi sekä tar.gz- että zip-tiedostomuodossa. Kun käytät Docker-kuvia, kokeile Docker-työtä komennolla Sphinx-komentojen kutsumiseksi.

Ladattavien asiakirjojen viittaaminen¶

Upouusi pääte kaikille normaaleille datatiedostoille. Uusi pickle Builder kokeilee sen hyvää alaluokkaa. Sinun on määritettävä, mitkä tiedostot löytyvät milläkin manuaalisivulla theman_users-järjestelyarvon avulla.

Kattavien API-suositusten luominen¶

Sen luontityökalua voidaan käyttää uuden Sphinx/Docutils-tiedoston "Reader for Transform to Writer" -putken virheenkorjaukseen. Jokaiselle korkeimmalle dokumentille tai alihakemistolle luodaan yksi .pot-hakemistomalli. Sen luontityökalu luo gettext-layout-viestiluetteloita.

Lue kaikkien ulkoisten verkkosivustolinkkien vakaus. Luo vinkkejä opassivuille groff-rakenteessa UNIX-järjestelmille. Tämä merkki on hyvä ehdokas funktiolle standard_character. Useiden suunnitelmien tapauksessa voit mahdollisesti muuttaa "mikä tahansa" tietyksi merkiksi. Kun käytät lauseketta, jota ei ehkä ole mainittu sanastossa, saat erinomaisen varoituksen luonnin aikana. Linkki määritettyyn asiakirjaan; uuden asiakirjan otsikko on läheinen sukulainen tai muuten absoluuttinen polku, joka on kirjainkoon suhteen hankala ja herkkä jopa näytölle.

Huomaa, että rinohtype-komennolla on suora PDF-tiedostojen rakennustyökalu. Kelvollisen PDF-tiedoston luomiseen tarvitaan komentoriviyksikkö hiutil, joka on rajoitettu Mac-käyttöjärjestelmälle X 10.6 ja uudemmille. Tämän tyyppisiä tiedostoja ei oteta huomioon muiden dokumentaatioversioiden vuoksi.

Uuden rakentajan tukemien valokuva-alustojen MIME-muotoinen valikko. Kuvadatakokeilu näytti olevan ostoksilla, missä ne näyttävät olevan täällä. Kun haluat luoda linkkejä tällaisiin dokumentteihin dokumentaatiosi ulkopuolella, se voidaan tehdä käyttämällä sphinx.ext.intersphinx. Python-salasanan tallentamisessa on melko yleistä lisätä paljon papereita lähdedokumentteihin, dokumentaatioketjuun. Se ei ole summa, ja tiedosto saa aidon dokumentaation forenumerate(); Sphinx pystyy löytämään ne ja luomaan niihin yhteyden. Tämä merkintä voi luoda linkin uusiin dokumentteihin enumerate()-funktion ulkopuolella.

Ristiviittaukset muihin erittäin kiinnostaviin kohteisiin¶

Esimerkiksi Pythonin enumerate()-funktion dokumentoimiseksi voit laittaa which-tiedoston yhteen lähdekooditiedostoistasi. Esimerkiksi kun katsot uutta HTML-versiota, voit testata uutta lähdekoodia – käytä sivupalkin "Näytä resurssi" -koukkua. Kuka tahansa voi luoda uuteen toctree-puuhun listattuja tiedostoja ja voit lisätä artikkeleita, ja niiden tiedostonimet rekisteröidään (uusimpaan maxdepth-tasoon asti) siinä kohdassa, johon toctree-direktiivi lisätään. Lisättävät tiedostot annetaan tiedostotunnisteissa, mikä tarkoittaa lyhyesti sanottuna sitä, että poistut tiedostotunnisteiden laajennuksesta ja käytät kauttaviivoja (/) luetteloerottimina. Tämä on yksi tärkeimmistä ongelmista, joita Sphinx lisää reStructuredText-muodossa, joka on tapa yhdistää useita tiedostoja samalle tasolle datasta.

Aiemmin mainitsimme, että uusin conf.py-tiedosto säätelee, miten Sphinx käsittelee artikkeleitasi. Jokaiselle verkkotunnukselle on omat säännöt uusien allekirjoitusten ulkoasusta ja varmista, että uusi muotoiltu sisältö näyttää oikeudenmukaiselta. Muussa tapauksessa luo tiettyjä ominaisuuksia, kuten linkkejä parametrimalleihin, esimerkiksi C/C++-verkkotunnuksiin. Ohjeen uusi konflikti on kuvaamasi objektin tavaramerkki, ja viesti on sen tiedostoissa.

Joten sen luontityökalu tuottaa identtisen tuotoksen kuin itsenäinen HTML-rakentaja, mutta se luo myös Qt-apuohjelmien tukitiedostoja, jotka mahdollistavat uuden Qtcollection-generaattorin keräämisen. Sen luontityökalu tuottaa saman suorituskyvyn kuin itsenäinen HTML-luontityökalu, mutta se tuottaa myös HTML-apuohjelmia, jotka mahdollistavat uuden Microsoft HTML HelpWorkshopin avulla niiden keräämisen yhdeksi CHM-tiedostoksi. Se on tehokas HTML-rakentaja, joka yhdistää koko projektin yhteen tuottavuustiedostoon. (On sanomattakin selvää, että se toimii vain rajoitettujen ohjelmien kanssa.) Uutta tiedostoa kutsutaan ics-asetustiedostoksi.

Useammat suunnittelijat saattavat käyttää lisälaajennuksia. He ovat Sphinx-kehittäjien keskipisteessä. Hahmon on hyvä pyrkiä löytämään kelvollinen osoite viitetekstilleen. Sen ei tarvitse olla samassa tiedostossa kuin merkintöjen määritelmässä, mukaan lukien Python-dokumentit, joissa on maailmanlaajuinen sanasto glossary.rst-tiedostosta. Hyvä sanasto luodaan käyttämällä glossary-direktiiviä, joka sisältää kuvausluettelon termeistä ja määritelmistä. Se luo yhteyden valintadirektiiviin, jos sellainen on saatavilla.

Jotta voit leikkiä intersphinxillä, sinun kannattaa laukaista ne conf.py-tiedostossa lisäämällä uusi merkkijono 'sphinx.ext.intersphinx' extensionslist-luetteloon ja asettamalla intersphinx_mapping-konfiguraation. Uudet tiedostot suojataan UTF-8-koodauksessa automaattisesti, koska ne ilmaistaan ​​encodingdeklaraatiolla ensimmäisellä rivillä. Muista vain, että uusin tiedosto käyttää Pythonin lauserakennetta, johon kuuluu ketju, numero, hakemistot jne. Jos haluat mukauttaa hyvän konfiguraatioarvon, jota ei ole suoraan lisätty sphinx-quickstartilla, lisää vain uusi määritys. Uusin Python-sivuston nimi ja usein on oletusverkkotunnus, joten sinun ei tarvitse lisätä uuden merkinnän etuliitettä verkkotunnukseen. ReStructuredText antaa yksityiskohtaisen johdannon reStructuredTextiin ja lisää Sphinxin lisäämiä merkintöjä.