Tämä luo HTML-dokumentit valitsemaasi luontiluetteloon. Nämä voidaan tehdä ajamalla generate rakentajan nimelle. Sphinx-lähdekoodissa voit käyttää standardreStructuredTextin ominaisuuksia.
- Sphinxdoc/sphinx-latexpdf sisältää TeXLive-paketteja.
- Älä käytä __all__-elementtiä uutta moduulia tarkastellessasi, jotta voit dokumentoida sen.
- Mikä on ehdottomasti säätelyn arvoinen tuoreen docstringsin genetiikan suhteen. Jos asetus on Aito, tuore docstring lajille, muuten vaiheet, muuten selvästi ilmaistu, periytyy äideiltä.
- Se myönnetään vain silloin, kun harkitaan uutta perintöpäätöstä.
Asennus¶: ilmaiset kolikkopelit verkossa
Tuotetaan aina, kun Autodoc-ominaisuudet lukevat ja voit käsitellä erinomaisen dokumenttijonon. On todellakin syytä hallita uusien dokumenttijonojen periytyvyyttä. Jos asetuksena on Korjaa, uusin dokumenttijono periytyy luokilta, vaiheilta tai jopa selkeästi sijainnilta. On tapana, että säilytystyyppisiä aliaksia ei välttämättä luetella dokumentissa. Ylimääräisillä ominaisuuksilla, muuten toiminnoilla ei ole tyyppivihjeitä kuvauksessa, koska on epäkäytännöllistä näyttää rehellisesti kaikkia mahdollisia ylikuormituksia täydellisen parametriluettelon jälkeen.
Satamatyöläinen¶
Hyvän Sphinx-tyyppisen yksinkertaisen ilmaiset kolikkopelit verkossa tekstitiedostolähteen juuriluetteloa kutsutaan syyhakemistoksi. Kun olet myös tämän suorittanut, voit siirtyä asennustiedostoon, jossa on uusi johdanto Sphinxin käyttämään oletusmerkintätyyliin, reStructuredText. Tiedoston tarkoituksena on antaa sinulle välitön esimakua siitä, mitä Sphinx kokeilee ja miten voit käyttää sitä.
- Löydät lukuisia keskusteluja laajennuksista sphinx-contriborganizin sivuilta.
- Luo automatisoituja paperitöitä, jotta tavoiteluokituksessa on erityisiä ihmisiä, jotka on merkitty "dunder"-brändeiksi. Mukana ovat kaikki sinetöidyt nimet, joissa on kaksinkertainen alaviiva, ikä.
- Ja tekee linkin upouuteen vastaavaan envvar-direktiiviin, jos sellainen on saatavilla.
Ristiviittaukset¶
Tarjottu uusi tiedostonimi on usein uuden hakemiston mukainen, jossa nykyinen lähdetiedosto sijaitsee. Jos ne ovat puhtaita (alkaen /-merkillä), se otetaan huomioon päälähdehakemiston mukaisesti. Linkki haluttuun tiedostoon; uuden tiedoston tunniste on suhteellinen tai absoluuttinen polku, joka on yleensä kirjainkoon suhteen herkkä Window-ympäristössä. Se annetaan vain, kun uusi reveal-genetics-asetus on annettu. Perusteet on luettelo luokista, joita datankäsittelijä voi muokata määrittääkseen, mitä Sphinx jättää toiminnolle. Jos rivi ei täsmää, uusi tuloksena oleva dokumenttimerkkijono olisi tyhjä, joten muutoksia ei tehtäisi, ellei keepempty-arvo ole tosi.
Sivusto on joukko siihen kuuluvia objektityyppejä, jotka on yksityiskohtaisesti merkitty merkinnöillä, jotka auttavat luomaan ja joihin voi viitata. Sphinxin päätavoitteena on ehdottomasti yksinkertaisten tiedostojen luominen erillään objektista (yleisen tyylin sisällä) kaikilla aloilla. Mutta ei, Sphinx-pikakäynnistysohjelmisto tarjoaa hyvän Makefile-tiedoston, ja voit luoda amake.bat-tiedoston, joka helpottaa elämääsi entisestään.
Jäljitykset ovat hyvä luettelo merkkijonoista – valmiin dokumenttimerkkijonon uudet ääriviivat – joita käsittelijä voi muokata parantaakseen Sphinxin tuottavuutta. Tämä on ongelmallista, jos lähdekoodi ei tue kommentteja, kuten jos se käyttää vain tyyppimerkintöjä tai ei tue minkäänlaisia vihjeitä. Resurssikoodin kommentit täydentävät unohtuneita merkintöjä, jos arvo on True.
Vältä __all__-komennon käyttöä uutta komponenttia analysoidessasi, jotta voit dokumentoida sen. Vaihtoehtoisesti autodoc voi ymmärtää hyvän docstring-komennon uusimmassa versiossa tämän jälkeen. Jos haluat NumPyn tai Yahoo rakentavan docstring-komennot uudelleenrakennetuiksi tekstiksi, voit antaa napoleon-laajennuksen kokeilla esikäsittelijää muuntaa docstring-komennot oikeaksi uudelleenrakennetuksi tekstiksi ennen kuin autodoc käsittelee ne. Tulet luomaan erinomaisen fiktiivisen ohjelmistopaketin satunnaisten ruokailukaavojen luomiseksi, jotka toimivat hyvänä ohjenuorana koko prosessissa, eikä niiden asianmukaiseen tallentamiseen ole tarkoitus. Yleensä paketin nimi on python3-sphinx, python-sphinx tai sphinx. Katso lisätietoja sphinx-generate-boy-sivulta.
