Viestit
Uusi koulutus on suunnattu Sphinxin uusille tulokkaille, jotka ovat valmiita oppimaan ideoiden rakentamisen ja järjestelyn bonuskoodi Hejgo perusteet. Voit myös ladata tilannekuvan Git-repositoriostasi joko tar.gz- tai zip-muodossa. Käyttäessäsi Docker-kuvia voit tutkia Docker-työtä tarvittaessa Sphinx-komentojen käynnistämiseksi.
Verkkoasiakirjoihin viittaaminen¶ | bonuskoodi Hejgo
Uusi pääte kaikille tavallisille dokumenteille. Uusimmat pickle creatorit ovat erinomainen alaluokka siitä. Sinun on määritettävä, mitä tietoja käytetään näillä ohjesivuilla theman_users-asetusarvolla.
Täydellisten API-tietueiden luominen¶
Joten sen rakentajaa käytetään uuden Sphinx/Docutils-ohjelman ”Viewer, jotta voit muuntaa sen kirjoittajaksi” -putken virheenkorjaukseen. Suurin osa tiedostosta tai alihakemistosta lisää yhden .cooking pot -hakemistomallin. Sen rakentaja tarjoaa gettext-layout-sisältöluetteloita.
Lue kaikkien ulkoisten takaisinlinkkien eheys. Luo manuaalisia profiileja groff-tyyliin omistaaksesi UNIX-järjestelmät. Tämä osa on hyvä ehdokas standard_character-funktiolle. Eri suunnitelmien tapauksessa voit muuttaa "mikä tahansa" tiettyyn rooliin. Jos käytät sanaa, jota ei mainita hyvässä sanastossa, saat hyvän varoituksen luonnin aikana. Yhteys vaadittuun tiedostoon; uuden tiedoston nimi voi olla sukulainen tai absoluuttinen polku, joka on kirjainkoon suhteen herkkä, erityisesti Windowsissa.
Muista, että rinohtype tarjoaa välittömän PDF-tiedostojen luontityökalun. Jotta voit luoda kelvollisen PDF-tiedoston, sen luontityökalu vaatii komentoriviyksikön hiutil, joka on rajoitettu Mac-tietokoneellesi, jonka käyttöjärjestelmäversio on X 10.6 tai uudempi. Nämä kansiot voidaan unohtaa muiden dokumenttityyppien vuoksi.
Uuden rakennustyökalun tukemien MIME-tyyppisten kuvaformaattien valikko. Valokuva-asiakirjat kokeilevat ostosta, josta ne näyttävät. Jos haluat luoda linkkejä tällaisiin dokumentteihin dokumentaatiostasi, voit tehdä sen sphinx.ext.intersphinx-tiedostolla. Python-salasanoja dokumentoitaessa on yleistä sijoittaa paljon dokumentteja lähdetiedostojen sisään, tietueiden merkkijonojen sisään. Sitä ei lasketa, joten dokumentti saa oikeat dokumentit forenumerate(); Sphinx voi löytää ne ja luoda linkin niihin. Tämä merkintä luo linkin enumerate()-funktion uusiin tiedostoihin.
Muiden kiinnostavien toimintojen ristiviittaukset¶
Esimerkiksi Pythonin riippuvaisen sisäisen funktion enumerate() dokumentoimiseksi voit laittaa sen johonkin lähdekooditiedostoistasi. Hyvänä esimerkkinä, kun näet uuden HTML-version, voit testata uusinta lähdekoodia it-tiedostolle – käytä sivupalkin "Kerro alkuperä" -linkkiä. Voit nyt luoda uuteen toctree-puuhun lisäämäsi tiedostot ja luoda sisällön, ja niiden osien otsikot lisätään (uuteen maxdepth-yläosaan) siihen kohtaan, johon toctree-direktiivi on sijoitettu. Lisättävät tiedostot annetaan tiedostonimikkeinä, mikä tarkoittaa, että pääset pois tiedostonimen laajennuksesta ja käytät lähetysviivoja (/) indeksierottimina. Tämä on yksi Sphinxin reStructuredText-ominaisuuteen lisäämistä ominaisuuksista, jotka on tarkoitettu yhdistämään useita tietoja yhdeksi tiedostoportaaksi.
Aiemmin mainitsimme, että uusi conf.py-tiedosto säätelee tarkalleen, miten Sphinx käsittelee artikkeleitasi. Verkkosivuston nimelle on omat lakinsa siitä, miltä uudet allekirjoitukset näyttävät ja tekevät uusista muotoiluista hakutuloksia oikeudenmukaisia. Muussa tapauksessa aseta tiettyjä asetuksia, kuten linkkejä, parametrimerkkeihin, kuten age.com, C/C++-verkkotunnuksiin. Direktiivin uusi argumentti on kuvailemasi kohteen allekirjoitus, ja viesti on tätä varten tarkoitettu tiedosto.
Tämä luontityökalu tarjoaa saman tuoton kuin itsenäinen HTML-luontityökalu, mutta luo myös Qt-aputiedostojen kokoelman tukitiedostoja, joiden avulla uusi Qtcollection-luontityökalu voi auttaa sinua keräämään niitä. Se luontityökalu tarjoaa samanlaisen tulosteen kuin itsenäinen HTML-luontityökalu, mutta luo myös HTML Assist -tukitiedostoja, joiden avulla uusin Microsoft HTML HelpWorkshop voi kerätä ne CHM-tiedostona. Tämä on tehokas HTML-rakentaja, joka yhdistää kaiken investoinnin sinulta tulostettavaan tiedostoon. (Tietenkin se toimii vain nopeampien projektien kanssa.) Uusinta tiedostoa kutsutaan likethe-lähdetiedostoksi.
Paljon lisää kehittäjiä tulee lisää laajennusten avulla. He työskentelevät Sphinx-kehittäjien sisällä. Tämä rooli pyrkii löytämään paremmin sopivan osoitteen viitetekstiviestilleen. Sen ei tarvitse olla samassa asiakirjassa kuin merkintöjen määritelmä, mukaan lukien Python-dokumentit, joissa on yksi kansainvälinen sanasto glossary.rst-tiedostosta. Erinomainen sanasto luodaan käyttämällä glossary-direktiiviä, joka sisältää merkitysluettelon sanoineen ja määritelmineen. Se luo linkin ratkaisudirektiiviin, jos se on saatavilla.
Jotta voit leikkiä intersphinxin kanssa, sinun on otettava se käyttöön conf.py-tiedostossa lisäämällä uusi sekvenssi 'sphinx.ext.intersphinx' extensionslist-luetteloosi ja asettamalla sen intersphinx_mapping-konfiguraatioarvoon. Uusin tiedosto tallennetaan automaattisesti UTF-8-muodossa, kuten ensimmäisellä rivillä olevassa koodausilmoituksessa on ilmoitettu. Muista, että uusi tiedosto käyttää Python-lauserakennetta ketjulle, määrälle, listauksille jne. Jos haluat mukauttaa hyvän konfiguraatioarvon, joka ei ole automaattisesti ylimääräistä sphinx-quickstartissa, lisää vain uusi projekti. Uusi Python-verkkotunnuksen nimi on myös vakioverkkotunnus, joten sinun ei tarvitse lisätä verkkotunnuksen uuden merkinnän etuliitettä. ReStructuredText laajemman integraation saamiseksi reStructuredTextiin ja Sphinxin lisäämiin merkintöihin.