Sphinx (dokumentationsgenerator)
 | |
| Utvecklare | Georg Brandl |
|---|---|
| Initial release | 21 mars 2008 |
| Stabil frisättning | 4.4.0 / 17 januari 2022
|
| Förvar | |
| Skrivet i | Pytonorm |
| Operativ system | Cross-plattform |
| Typ | Dokumentationsgenerator |
| Licens | BSD |
| Hemsida | |
Sphinx är en dokumentationsgenerator skriven och används av Python-communityt. Det är skrivet i Python och används även i andra miljöer.
Syfte och funktion
Sphinx konverterar reStructuredText- filer till HTML -webbplatser och andra format inklusive PDF , EPub , Texinfo och man .
reStructuredText är utökningsbar och Sphinx utnyttjar sin utvidgbara natur genom ett antal tillägg – för att autogenerera dokumentation från källkod, skriva matematisk notation eller markera källkod, etc.
HTML-teman
Sphinx ger möjligheten att tillämpa teman på HTML och HTML-baserade format. Sphinx har flera inbyggda teman inklusive alabaster, classic, sphinxdoc och scrolls. Populära teman som kan installeras som Python-moduler inkluderar:
- Läs dokumenten
- Sphinx Bootstrap
- Guzzle
- Documatt
Historia och användning
Den första offentliga utgåvan, version 0.1.61611, tillkännagavs den 21 mars 2008. Den utvecklades för, och används flitigt av, Python -projektet för dokumentation.
Sedan introduktionen 2008 har Sphinx antagits av många andra viktiga Python-projekt, inklusive Bazaar , SQLAlchemy , MayaVi , SageMath , SciPy , Django och Pylons . Den används också för Blenders användarmanual och Python API-dokumentation.
2010 tillkännagav Eric Holscher skapandet av Read the Docs -projektet som en del av ett försök att göra underhållet av mjukvarudokumentationen enklare. Read the Docs automatiserar processen att bygga och ladda upp Sphinx-dokumentation efter varje commit .
Linux kärna
Linuxkärnans dokumentationsundersystem genomgick förändringar under 2016. Från och med 4.7-cykeln började dokumentationen gå över till att använda Sphinx.
Se även
externa länkar
-
Sphinx dokumentationsgenerator projektwebbplats
- Läs Docs storskaliga, samarbetande dokumentationsvärd som drivs av Sphinx