Szfinx (dokumentációs generátor)

Az oldal jelenlegi verzióját még nem ellenőrizték tapasztalt közreműködők, és jelentősen eltérhet a 2020. augusztus 20-án felülvizsgált verziótól ; az ellenőrzések 2 szerkesztést igényelnek .
Szfinksz
Típusú Dokumentáció generátor
Fejlesztő Georg Brandl
Beírva Piton
Operációs rendszer többplatformos szoftver
Első kiadás 2008. március 21 ( 2008-03-21 )
legújabb verzió

4.2.0

[1] (2021. szeptember 12. ) ( 2021-09-12 )
Olvasható fájlformátumok Átstrukturált szöveg
Engedély BSD
Weboldal sphinx-doc.org

A Sphinx  egy olyan dokumentáció-generátor , amely a reStructuredText fájlokat HTML webhelyekké és más formátumokká ( PDF , EPub és man ) alakítja át . Számos bővítményt használ a reStructuredTexthez (például forráskód-dokumentáció automatikus generálásához, matematikai képletek generálásához vagy forráskód kiemeléséhez). Az első nyilvános kiadást (0.1.61611-es verzió) 2008. március 21-én jelentették be. [2] Kifejlesztették és széles körben használták a Python programozási nyelv , valamint további moduljainak dokumentálására. [3]

2008-as megalakulása óta a Sphinxet számos fontos Python projekt alkalmazta: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django és Pylons ; a Blender Python API dokumentálására is szolgál . [4] A Read the Docs projektet a szoftverdokumentáció támogatásának elősegítésére hozták létre . [5] Automatizálja a Sphinx dokumentáció létrehozásának és betöltésének folyamatát a forráskódhoz való minden véglegesítés után. A projektet a Python Software Foundation támogatja . [6]

Lásd még

Linkek

  1. ↑ Változások a Szfinxben . Letöltve: 2019. január 29. Az eredetiből archiválva : 2019. január 30.
  2. ↑ Elengedték a Szfinxet! » És most valami teljesen Pythonic... . És most valami teljesen Pythonic... . Georg Brandl. Letöltve: 2011. április 3. Az eredetiből archiválva : 2013. január 26..
  3. ↑ Ezekről a dokumentumokról - Python v2.7.1 dokumentáció . Python dokumentáció . Python Software Foundation. Letöltve: 2011. április 3. Az eredetiből archiválva : 2013. január 26..
  4. ↑ Dev:2.5/Py/API/API-referencia generálása - BlenderWiki! (nem elérhető link) . Blender Wiki . Blender alapítvány. Letöltve: 2011. április 6. Az eredetiből archiválva : 2013. január 26.. 
  5. ↑ Bejelentjük, hogy olvassa el a Dokumentumokat . Szörfözés Kansasben . Eric Holscher. Letöltve: 2011. április 6. Az eredetiből archiválva : 2013. január 26..
  6. ↑ Python Software Foundation Hírek: PSF Funds readthedocs.org . Python Software Foundation hírek . Python Software Foundation. Letöltve: 2011. április 6. Az eredetiből archiválva : 2013. január 26..

Irodalom

 Piton
Közösség
Megvalósítások
Egyéb