Sphinx (dokumentationsgenerator)

Den aktuella versionen av sidan har ännu inte granskats av erfarna bidragsgivare och kan skilja sig väsentligt från versionen som granskades den 20 augusti 2020; kontroller kräver 2 redigeringar .
Sfinx
Sorts Dokumentationsgenerator
Utvecklaren Georg Brandl
Skrivet i Pytonorm
Operativ system plattformsoberoende programvara
Första upplagan 21 mars 2008 ( 2008-03-21 )
senaste versionen

4.2.0

[1] (12 september 2021 ) ( 2021-09-12 )
Läsbara filformat Omstrukturerad text
Licens BSD
Hemsida sphinx-doc.org

Sphinx  är en dokumentationsgenerator som konverterar reStructuredText- filer till HTML - webbplatser och andra format ( PDF , EPub och man ). Den använder ett antal tillägg för reStructuredText (till exempel för att automatiskt generera källkodsdokumentation, generera matematiska formler eller markera källkod). Den första offentliga utgåvan (version 0.1.61611) tillkännagavs den 21 mars 2008. [2] Det utvecklades och användes i stor utsträckning för att dokumentera programmeringsspråket Python , såväl som dess ytterligare moduler. [3]

Sedan starten 2008 har Sphinx antagits av många viktiga Python-projekt: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django och Pylons ; det används också för att dokumentera Blender Python API. [4] Read the Docs- projektet skapades för att underlätta stödet för programvarudokumentation . [5] Det automatiserar processen att skapa och ladda Sphinx-dokumentation efter varje commit till källkoden. Projektet sponsras av Python Software Foundation . [6]

Se även

Länkar

  1. ↑ Förändringar i Sphinx . Hämtad 29 januari 2019. Arkiverad från originalet 30 januari 2019.
  2. ↑ Sphinx släpps! » Och nu till något helt pytoniskt... . Och nu till något helt pytoniskt... . Georg Brandl. Hämtad 3 april 2011. Arkiverad från originalet 26 januari 2013.
  3. ↑ Om dessa dokument - Python v2.7.1 dokumentation . Python dokumentation . Python Software Foundation. Hämtad 3 april 2011. Arkiverad från originalet 26 januari 2013.
  4. ↑ Dev:2.5/Py/API/Generating API Reference - BlenderWiki! (inte tillgänglig länk) . Blender Wiki . Blender Foundation. Hämtad 6 april 2011. Arkiverad från originalet 26 januari 2013. 
  5. ↑ Meddelande Läs dokumenten . Surfa i Kansas . Erik Holscher. Hämtad 6 april 2011. Arkiverad från originalet 26 januari 2013.
  6. ↑ Nyheter om Python Software Foundation: PSF Funds readthedocs.org . Nyheter om Python Software Foundation . Python Software Foundation. Hämtad 6 april 2011. Arkiverad från originalet 26 januari 2013.

Litteratur

 Pytonorm
gemenskap
Genomföranden
Övrig