Sfinksi (dokumentaatiogeneraattori)

Kokeneet kirjoittajat eivät ole vielä tarkistaneet sivun nykyistä versiota, ja se voi poiketa merkittävästi 20. elokuuta 2020 tarkistetusta versiosta . tarkastukset vaativat 2 muokkausta .
Sfinksi
Tyyppi Dokumentaatiogeneraattori
Kehittäjä Georg Brandl
Sisään kirjoitettu Python
Käyttöjärjestelmä monikäyttöinen ohjelmisto
Ensimmäinen painos 21. maaliskuuta 2008 ( 21-03-2008 )
uusin versio

4.2.0

[1] (12. syyskuuta 2021 ) ( 2021-09-12 )
Luettavat tiedostomuodot Uudelleenjärjestetty teksti
Lisenssi BSD
Verkkosivusto sphinx-doc.org

Sphinx  on dokumentaatiogeneraattori, joka muuntaa reStructuredText- tiedostot HTML - sivustoiksi ja muihin muotoihin ( PDF , EPub ja man ). Se käyttää useita laajennuksia reStructuredTextiin (esimerkiksi automaattisesti lähdekoodidokumentaation luomiseen, matemaattisten kaavojen luomiseen tai lähdekoodin korostamiseen). Ensimmäinen julkinen julkaisu (versio 0.1.61611) julkistettiin 21. maaliskuuta 2008. [2] Se kehitettiin ja sitä käytettiin laajasti Python -ohjelmointikielen sekä sen lisämoduulien dokumentoimiseen. [3]

Sen perustamisesta vuonna 2008 lähtien Sphinx on otettu käyttöön monissa tärkeissä Python-projekteissa: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django ja Pylons ; sitä käytetään myös Blender Python API:n dokumentointiin. [4] Read the Docs -projekti luotiin helpottamaan ohjelmistodokumentaation tukemista . [5] Se automatisoi Sphinx-dokumentaation luonti- ja latausprosessin jokaisen lähdekoodiin sitoutumisen jälkeen. Hanketta sponsoroi Python Software Foundation . [6]

Katso myös

Linkit

  1. ↑ Sfinksin muutokset . Haettu 29. tammikuuta 2019. Arkistoitu alkuperäisestä 30. tammikuuta 2019.
  2. ↑ Sfinksi on vapautettu! » Ja nyt jotain täysin pytonista... . Ja nyt jotain täysin pytonista... . Georg Brandl. Haettu 3. huhtikuuta 2011. Arkistoitu alkuperäisestä 26. tammikuuta 2013.
  3. ↑ Tietoja näistä asiakirjoista - Python v2.7.1 - dokumentaatio . Python-dokumentaatio . Python Software Foundation. Haettu 3. huhtikuuta 2011. Arkistoitu alkuperäisestä 26. tammikuuta 2013.
  4. ↑ Kehittäjä:2.5/Py/API/API-viitteen luominen - BlenderWiki! (linkki ei saatavilla) . Blender Wiki . Blender Foundation. Haettu 6. huhtikuuta 2011. Arkistoitu alkuperäisestä 26. tammikuuta 2013. 
  5. ↑ Ilmoitamme Read The Docsista . Surffausta Kansasissa . Eric Holscher. Haettu 6. huhtikuuta 2011. Arkistoitu alkuperäisestä 26. tammikuuta 2013.
  6. ↑ Python Software Foundation -uutiset: PSF Funds readthedocs.org . Python Software Foundation -uutiset . Python Software Foundation. Haettu 6. huhtikuuta 2011. Arkistoitu alkuperäisestä 26. tammikuuta 2013.

Kirjallisuus

 Python
Yhteisö
Toteutukset
Muut