Automaattinen asiakirjojen luonti salasanalla

28 Jan Automaattinen asiakirjojen luonti salasanalla

Tämä tuore esimerkki on tarkoitettu Sphinx-aloittelijoille, jotka haluavat oppia ideoiden luomisen perusteet ja valmistautumisen. Voit myös https://suomi-casinos.com/kaikki-nettikasinot/ saada tilannekuvan Git-reposta joko tar.gz- tai zip-muodossa. Kun käytät Docker-kuvia, kokeile Docker-keskitystä järjestykseen, jotta voit kutsua Sphinx-komentoja.

Verkkodataan viittaaminen¶

Uusin pääte kaikille tavallisille dokumenteille. Uudet suolakurkkutyökalut ovat erinomainen alaluokka siitä. Sinun on määritettävä, mitkä tiedot sisällytetään ja mitkä theman_profiles-järjestelyn ohjesivut ovat arvokkaita.

Kokonaisten API-viittausten tuottaminen¶

Että it builder -työkalua voidaan käyttää uuden Sphinx/Docutils-putken “Reader for Transform to Writer” virheenkorjaukseen. Jokaiselle korkeamman tason tiedostolle tai alihakemistolle luodaan oma .pot-hakemistorakenne. Joten it builder luo gettext-build-sisältöluetteloita.

Lue monien ulkoisten linkkien eheys. Tee manuaalisivuja groff-rakenteessa UNIX-järjestelmille. Joten se osa on hyvä ehdokas default_character-asetukselle. Jos haluat käyttää useita tavoitteita, voit muuttaa "mikä tahansa"-kohdan tietyksi osaksi. Jos käytät termiä, jota ei ole selitetty sanastossa, saat varoituksen koontiversion aikana. Linkitä määritettyyn tiedostoon; uuden tiedoston nimi on läheinen sukulainen tai absoluuttinen polku, ja se on aina kirjainkoon suhteen herkkä, erityisesti Windowsissa.

Huomaa, että rinohtype-komennolla on saatavilla välitön PDF-tiedostojen luontityökalu. Kelvollisen PDF-tiedostojen luomiseen tarvitaan komentorivityökalu hiutil, joka on saatavilla vain Mac-tietokoneille, joissa on OS X 10.6 tai uudempi. Muut dokumenttityypit jättävät nämä kansiot huomiotta.

Uuden luojan tukemien kuvatiedostojen MIME-muotoinen valikko. Kuvatiedostot näkyvät siinä muodossa, jossa ne näkyvät. Jos haluat luoda linkkejä tiedostojen lisäämiseksi dokumentaatiostasi, voit tehdä sen käyttämällä sphinx.ext.intersphinx-komentoa. Python-koodia kirjoitettaessa on yleistä sijoittaa useita tiedostoja lähdetiedostojen sisään tiedostomerkkijonojen sisällä. Se ei numeroi, ja tiedosto saa alkuperäisen dokumentaation forenumerate(); Sphinx voi löytää ne ja luoda linkin niihin. Tämä merkintä voi luoda linkin uusimpiin tiedostoihin enumerate()-funktiosta.

Muiden mielenkiintoisten kohteiden ristiviittaukset¶

Esimerkiksi Pythonin DocumentTextin enumerate()-moodin sisällä sijoitat which-funktion arvoon 1 lähdetiedostoistasi. Esimerkiksi uusimman HTML-version katselussa voit kokeilla uutta lähdetiedostoa – käytä sivupalkin "Näytä alkuperä" -kytkentää. Kuka tahansa voi luoda uuteen toctree-puuhun sijoittamasi tiedot ja voit luoda artikkeleita, ja niiden hakemistojen otsikot voidaan yhdistää (uusimpaan maxdepth-korkeuteen asti) siinä kohdassa, johon toctree-direktiivi sijoitetaan. Lisättävät tiedostot annetaan tiedostonimissä, mikä tarkoittaa, että poistut tiedostonimen päätteestä ja käytät kauttaviivoja (/) luetteloerottimina. Tämä on yksi tärkeimmistä syistä, miksi Sphinx parantaa reStructuredTextiä, tapaa yhdistää useita tiedostoja yhteen hierarkiaan datan ulkopuolella.

Ennen kuin sanoin, uusin conf.py-tiedosto ohjaa sitä, miten Sphinx käsittelee kirjoituksesi. Jokaiselle verkkotunnukselle voi olla omat lakinsa ja määräyksensä sen perusteella, miltä uudet allekirjoitukset näyttävät ja miten uusin muotoiltu tulostehaku tehdään. Vaihtoehtoisesti voit lisätä erityisiä tiedostoja, kuten linkkejä parametriversioihin, esim. C/C++-verkkotunnuksiin. Direktiivisi uusin argumentti on kuvailemasi kohteen tavaramerkki, sisältö on sen tiedostot.

Tämä it-rakentaja tarjoaa vertailukelpoisen tuoton kuin itsenäinen HTML-rakentaja, mutta se tuottaa myös Qt-apuohjelmia, joiden avulla uusi Qtcollection-luontiohjelma voi kerätä tietoja. Joten it-rakentaja tarjoaa vertailukelpoisen tuottavuuden kuin itsenäinen HTML-rakentaja, mutta se tuottaa myös HTML-apuohjelmia, jotka mahdollistavat uuden Microsoft HTML HelpWorkshopin, jotta voit kerätä ne CHM-tiedostoon. Tämä on HTML-rakentaja, joka yhdistää koko liiketoiminnan sinun tulostetiedostossa. (Tietenkin, jotta se toimii vain lyhyempien ideoiden kanssa.) Uutta tiedostoa kutsutaan ls-lähdetiedostoksi.

Paljon useammat suunnittelijat käyttävät enemmän laajennuksia. Ne keskittyvät Sphinx-kehittäjiin. Tämä helpottaa roolin suorittamista paremmin löytääkseen sopivan osoitteen viitetekstiviestilleen. Sen ei tarvitse olla samassa tiedostossa, koska sanamerkinnöissä, mukaan lukien Python-dokumenteissa, on yksi maailmanlaajuinen sanasto tiedostosta glossary.rst. Hyvä sanasto luodaan käyttämällä glossary-direktiiviä, jossa on kuvausluettelo, jossa on ehtoja ja määritelmiä. Tämä luo yhteyden valintadirektiiviin, jos sellainen on saatavilla.

Jotta voit pitää hauskaa intersphinxin kanssa, sinun on aktivoitava ne conf.py-tiedostossa lisäämällä uusin merkkijono 'sphinx.ext.intersphinx' extensionslist-luetteloon ja asettamalla sen intersphinx_mapping-konfiguraatiossa. Uusi tiedosto tallennetaan automaattisesti UTF-8-muotoon, koska ensimmäisellä rivillä oleva encodingdeclaration osoittaa sen. Muista vain, että uusi tiedosto käyttää Python-syntaksia ketjulle, määrälle, listauksille jne. Jos haluat mukauttaa konfiguraatioarvoa, jota sphinx-quickstart ei lisää automaattisesti, luo vain uusi määritys. Uusi Python-verkkotunnus on myös oletusverkkotunnus, joten sinun ei tarvitse lisätä uutta merkintää verkkotunnuksen etuliitteeksi. ReStructuredText on laajempi lisäys reStructuredTextiin sekä Sphinxistä lisättyihin merkintäkuviin.