Sphinx (generator dokumentacije)
Ovaj članak možda zahteva čišćenje i/ili prerađivanje kako bi se zadovoljili standardi kvaliteta Vikipedije. Problem: Vikisintaksa, kategorije. |
Sphinx je generator dokumentacije napisan i korišćen u Pajton okruženju. On se takođe koristi i u drugim okruženjima.
Primena i funkcija
urediUloga Sphinx–a je da konvertuje reStructuredText fajlove u HTML vebsajtove i u druge formate kao što su PDF, EPub, Texinfo i man.
Na reStructuredText fajlove je moguće dodavati ekstenzije, i zbog njihove takve prirode Sphinx ih koristi uz razne ekstenzije– za automatko generisanje dokumentacije iz izvornog koda, za pisanje matematičkih izraza, za izdvajanje nekog dela koda, itd..
Istorija i upotreba
urediPrvo pojavljivanje verzije 0.1.61611 dogodilo se 21.marta 2008. godine.[1] Ta verzija napravljena je u svrhu projekta Python dokumentacije.[2]
Od njegovog pojavljivanja 2008. godine, Sphinx je bio prihvaćen od strane mnogih važnih Python projekata, uključujući Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django i Pylons. On je takođe korišćen kao uputstvo za upotrebu softvera Blender[3] i za Python API dokumentaciju.[4]
Tokom 2010. godine, Eric Holscher[5] najavio je kreiranje Read the Docs projekta sa željom da se olakša održavanje softverske dokumentacije. Read the Docs omogućio je automatizaciju procesa izrade i učitavanja Sphinx dokumentacije posle svakog izvršavanja.
Linux kernel
Podsistem dokumentacije za Linux kernel podvrgnut je promenama u 2016. godini.
Počevši od ciklusa 4.7, za dokumentaciju se počeo upotrebljavati Sphinx.[6]
- Govor na LCA2016: What I've learned as the kernel docs maintainer
- Govor na LCA2017: Kernel documentation: what we have and where it's going
Vidi još
urediReference
uredi- ^ Charette, Blaine (2011). „“And Now for Something Completely Different”: A “Pythonic” Reading of Pentecost?”. Pneuma. 33 (1): 59—62. ISSN 0272-0965. doi:10.1163/157007411x554703.
- ^ Documentation, Apress, 2010, str. 207—215, ISBN 978-1-4302-2757-1, Pristupljeno 2020-06-26
- ^ Blender Overview, Apress, 2009, str. 1—23, ISBN 978-1-4302-1976-7, Pristupljeno 2020-06-26
- ^ Conlan, Chris (2017), The Blender Interface, Apress, str. 1—9, ISBN 978-1-4842-2801-2, Pristupljeno 2020-06-26
- ^ Brevik, Eric (2015). „Announcing Read The Docs”. CSA News. 64 (3): 15—15. ISSN 1529-9163. doi:10.2134/csa2019.64.0319.
- ^ „GWI UPDATE 02 March 2016”. Human Rights Documents Online. Pristupljeno 2020-06-26.