Sphinx (generator de documentație)

Versiunea actuală a paginii nu a fost încă examinată de colaboratori experimentați și poate diferi semnificativ de versiunea revizuită pe 20 august 2020; verificările necesită 2 modificări .
Sfinx
Tip de Generator de documentație
Dezvoltator Georg Brandl
Scris in Piton
Sistem de operare software multiplatformă
Prima editie 21 martie 2008 ( 21.03.2008 )
ultima versiune

4.2.0

[1] (12 septembrie 2021 ) ( 2021-09-12 )
Formate de fișiere care pot fi citite Text restructurat
Licență BSD
Site-ul web sfinx-doc.org

Sphinx  este un generator de documentație care convertește fișierele reStructuredText în site-ul web HTML și în alte formate ( PDF , EPub și man ). Utilizează o serie de extensii pentru reStructuredText (de exemplu, pentru a genera automat documentația codului sursă, a genera formule matematice sau a evidenția codul sursă). Prima lansare publică (versiunea 0.1.61611) a fost anunțată pe 21 martie 2008. [2] A fost dezvoltat și utilizat pe scară largă pentru a documenta limbajul de programare Python , precum și modulele sale suplimentare. [3]

De la înființarea sa în 2008, Sphinx a fost adoptat de multe proiecte importante Python: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django și Pylons ; este, de asemenea, folosit pentru a documenta API-ul Blender Python. [4] Proiectul Read the Docs a fost creat pentru a facilita suportul pentru documentația software . [5] Automatizează procesul de creare și încărcare a documentației Sphinx după fiecare comitere la codul sursă. Proiectul este sponsorizat de Python Software Foundation . [6]

Vezi și

Link -uri

  1. ↑ Schimbări în Sfinx . Consultat la 29 ianuarie 2019. Arhivat din original la 30 ianuarie 2019.
  2. ↑ Sfinxul este lansat! » Și acum pentru ceva complet Pythonic... . Și acum pentru ceva complet Pythonic... . Georg Brandl. Consultat la 3 aprilie 2011. Arhivat din original pe 26 ianuarie 2013.
  3. ↑ Despre aceste documente - documentația Python v2.7.1 . Documentație Python . Python Software Foundation. Consultat la 3 aprilie 2011. Arhivat din original pe 26 ianuarie 2013.
  4. ↑ Dev:2.5/Py/API/Generating API Reference - BlenderWiki! (link indisponibil) . Blender Wiki . Fundația Blender. Consultat la 6 aprilie 2011. Arhivat din original pe 26 ianuarie 2013. 
  5. ↑ Anunțând Citiți documentele . Surfing în Kansas . Eric Holscher. Consultat la 6 aprilie 2011. Arhivat din original pe 26 ianuarie 2013.
  6. ↑ Știri Python Software Foundation: PSF Funds readthedocs.org . Python Software Foundation Știri . Python Software Foundation. Consultat la 6 aprilie 2011. Arhivat din original pe 26 ianuarie 2013.

Literatură

 Piton
Comunitate
Implementări
Alte