Sisältö
Johtopäätös autosummaryn kehittämä verkkosivu¶ Ja jälleen kerran, heti make html:n käynnistämisen jälkeen uusi tuloste on identtinen juuri ennen. Tutoriaalin edellisessä osiossa huomasit itse hyvän Python-tilan Sphinxin sisällä. Vaikka ei, conf.py voi sijaita myös toisessa indeksissä, tuoreessa asennushakemistossa. Sphinx.ext.intersphinx sisältää täydellisen kuvauksen intersphinxin ominaisuuksista.
Uusimman merkin käyttö¶
Toctree on itse asiassa erinomainen reStructuredText-direktiivi, erittäin joustava merkintätapa. Kun olet tässäkin valmis, voit siirtyä asennusoppaaseen uuden johdannon kanssa, jotta voit käyttää Sphinxin käyttämää oletusmerkintätyyliä, reStructuredTextiä. Muita kieliä on natiivisti saatavilla Sphinxissä salasanan dokumentointiin, mutta ne tarvitsevat laajennuksia automaattisen koodin dokumentoinnin hallitsemiseksi, mukaan lukien Inhal. Sphinxin ominaisuuksien esittelemiseksi salasanatiedostojen hallinnassa käytät Pythonia, joka tukee myös automaattisia tiedostotyyppejä. Voit tehdä hienon fiktiivisen ohjelmistopaketin satunnaisten ruokailutottumusten luomiseksi, jotka toimivat erinomaisena oppaana koko prosessin ajan, jotta se voidaan dokumentoida turvallisesti. Projekti sisältää narratiivisia, käsin kirjoitettuja asiakirjoja sekä automaattisesti luotuja API-dokumentteja.
Muiden kiinnostavien asioiden ristiviittaukset¶
Löydät lisätietoja uudesta suorituskykyrakenteesta sarjoittelutyökalusta. Sarjoittelutyökalu käyttää komponenttia, joka käyttää uutta Python-serialisointirajapintaa (esim. Pickle, JSON tai phpserialize) luotujen HTML-tiedostojen https://onlinekasinolla.com/crazy-monkey/ poistamiseen. Sinun on määritettävä, että tiedostot sisällytetään Texinfo-tietoihin texinfo_documentsconfiguration-arvon kautta. Joten it-rakentaja tuottaa Texinfo-tietoja, joita makeinfo-järjestelmä voi käsitellä tietotiedostoiksi. Joten it-rakentaja tarjoaa samanlaisen tulosteen kuin erillinen HTML-rakentaja, mutta tarjoaa myös tehokkaan epub-sovelluksen e-kirjaohjelmille.
Jokainen direktiivi päättää, voiko sillä olla vastalauseita ja kuinka paljon. Vastalauseet esitetään henkilökohtaisesti direktiivin sanamuodon jälkeisen kaksinkertaisen peräaukon jälkeen. Dokumentin päätarkoituksena on toimia hyvänä tervehdyssivuna ja pitää "tietopuun ruokapöydän" (eli toctreen) juurta. Dokumentin tavoitteena on antaa sinulle nopea valinta siitä, mikä Sphinx on ja miten sitä käytetään.
Verkkotunnus on itse asiassa kokoelma siihen kuuluvia objektityyppejä, jotka on täytetty merkinnöillä objektien luomiseksi ja niihin viittaamiseksi. Generate latexpdf suorittaa uuden Exudate-rakentajaohjelman ja kutsuu helposti uuden pdfTeXtoolchainin. Sphinx-quickstart-ohjelma kuitenkin luo erinomaisen Makefile-tiedoston, ja voit luoda amake.bat-tiedoston, joka helpottaa elämääsi tarpeidesi mukaan.
Tämä luo HTML-dokumentteja valitsemaasi luontihakemistoon. Nämä voidaan tehdä suorittamalla create-komento rakentajan nimimerkille. (Ne voivat sisältää itse toctree-direktiivejä, mikä tarkoittaa, että voit tarvittaessa luoda syvästi sisäkkäisiä hierarkioita.)
Varhaisin järjestely¶
Jokainen direktiivi määrittää, sallitaanko se blogien luomiseksi, ja voit käsitellä sitä sen sisällä. Artikkelit seuraavat asetuksia tai argumentteja tyhjän alueen jälkeen. Maxdepth on tällainen valinta toctree-direktiiviisi.
Tuo it-lista sisältää myös uuden Sphinx-määritystiedoston conf.py, jossa voit määrittää kaikki Sphinxin ominaisuudet, kuten lähteen tarkistamisen ja tiedostojen luomisen. He kuitenkin kopioivat uudet reStructuredText-lähdetiedostot uuteen _supply-listaan tulostushakemiston alla. it-luoja tarjoaa hakemiston jokaista reStructuredText-tiedostoa kohden. Tämä on lähes samanlainen kuin uusi reStructuredText-tiedosto, mutta suuri osa uusista merkinnöistä on poistettu luettavuuden parantamiseksi. Katso latex_files-tiedostosta ja luvusta Exudate-tulostuksen asetukset saatavilla olevat vaihtoehdot.
Tämä luontityökalu tarjoaa samanlaisen tuottavuuden kuin itsenäinen HTML-luontityökalu, mutta se luo myös GNOME Devhelp -tukitiedoston, jonka avulla uusin GNOME Devhelp -katseluohjelma voi päästä siihen käsiksi. Niinpä uusi documentmarkup/people.rst ei johda tuotantotiedostoon markup/others.html, vaan markup/rest/directory.html. Toiminnot ovat HTML-tiedostojen hakemisto, jossa jokaiselle tiedostolle annetaan nimi list.html ja se sijoitetaan alihakemistoon, jonka nimi on samanniminen kuin sen sivun nimi. Uuden rakentajan "nimi" on annettava uudelle -Yards- tai -b demand-range-vaihtoehdolle sphinx-create-komennolla rakentajan valitsemiseksi.