Sfinga (generátor dokumentace) - Sphinx (documentation generator)
 | |
| Vývojáři | Georg Brandl |
|---|---|
| První vydání | 21. března 2008 |
| Stabilní uvolnění | 3.3.0[1] / 2. listopadu 2020 |
| Náhled verze | 4.0.0 |
| Úložiště |  |
| Napsáno | Krajta |
| Operační systém | Cross-platform |
| Typ | Generátor dokumentace |
| Licence | BSD |
| webová stránka | sfinga-doc |
Sfinga je generátor dokumentace napsané a používané komunitou Pythonu. Je napsán v Krajta, a také se používá v jiných prostředích.
Účel a funkce
Sfinga se převádí reStructuredText soubory do HTML webové stránky a další formáty včetně PDF, EPub, Texinfo a muž.
reStructuredText je rozšiřitelný a Sphinx využívá jeho rozšiřitelnou povahu prostřednictvím řady rozšíření - pro automatické generování dokumentace ze zdrojového kódu, psaní matematické notace nebo zvýraznění zdrojového kódu atd.
Historie a použití
První veřejné vydání, verze 0.1.61611, bylo oznámeno 21. března 2008.[2] Byl vyvinut pro a je značně používán Krajta projekt dokumentace.[3]
Od svého zavedení v roce 2008 byla Sphinx přijata mnoha dalšími důležitými projekty Pythonu, včetně Bazar, SQLAlchemy, MayaVi, SageMath, SciPy, Django a Stožáry. Používá se také pro Mixér uživatelský manuál[4] a dokumentace Python API.[5]
V roce 2010 oznámil Eric Holscher[6] vytvoření Přečtěte si dokumenty projekt jako součást snahy o usnadnění údržby softwarové dokumentace. Read the Docs automatizuje proces vytváření a nahrávání dokumentace Sphinx po každém spáchat.
Linuxové jádro
Subsystém dokumentace linuxového jádra prošel změnami v roce 2016. Počínaje cyklem 4,7 začala dokumentace přecházet na použití Sphinx.[7]
- Přednáška na LCA2016: Co jsem se naučil jako správce dokumentace k jádru na Youtube
- Přednáška na LCA2017: Dokumentace k jádru: co máme a kam směřuje na Youtube
Viz také
Reference
- ^ „Změny ve Sfingě“. Sfinga.
- ^ „Sfinga je vydána!» A teď něco zcela pythonického ... “ A teď něco zcela pythonického .... Georg Brandl. Archivovány od originál dne 2012-03-22. Citováno 2011-04-03.
- ^ „O těchto dokumentech - dokumentace k Pythonu v2.7.1“. Dokumentace Pythonu. Softwarová nadace Python. Citováno 2011-04-03.
- ^ „Uživatelská příručka mixéru“. Blender Wiki. Blender Foundation.
- ^ „Dev: 2.5 / Py / API / Generating API Reference - BlenderWiki!“. Blender Foundation. Blender Foundation.
- ^ „Oznámení Číst dokumenty“. Novinky nadace Python Software Foundation. Eric Holscher. Citováno 2015-02-15.
- ^ „Aktualizace dokumentace jádra“. LWN.net. 2016-11-02.
externí odkazy
- Web projektu generátoru dokumentace sfingy
- Přečtěte si dokumenty rozsáhlý hostitel pro spolupráci s dokumentací využívající technologii Sphinx