Sphinx (генератор документације)
 | Овај чланак можда захтева чишћење и/или прерађивање како би се задовољили стандарди квалитета Википедије. Проблем: Викисинтакса, категорије. |
Sphinx је генератор документације написан и коришћен у Пајтон окружењу. Он се такође користи и у другим окружењима.
Примена и функција
[уреди | уреди извор]Улога Sphinx–а је да конвертује reStructuredText фајлове у HTML вебсајтове и у друге формате као што су PDF, EPub, Texinfo и man.
На reStructuredText фајлове је могуће додавати екстензије, и због њихове такве природе Sphinx их користи уз разне екстензије– за аутоматко генерисање документације из изворног кода, за писање математичких израза, за издвајање неког дела кода, итд..
Историја и употреба
[уреди | уреди извор]Прво појављивање верзије 0.1.61611 догодило се 21.марта 2008. године.[1] Та верзија направљена је у сврху пројекта Python документације.[2]
Од његовог појављивања 2008. године, Sphinx је био прихваћен од стране многих важних Python пројеката, укључујући Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django и Pylons. Он је такође коришћен као упутство за употребу софтвера Blender[3] и за Python API документацију.[4]
Током 2010. године, Eric Holscher[5] најавио је креирање Read the Docs пројекта са жељом да се олакша одржавање софтверске документације. Read the Docs омогућио је аутоматизацију процеса израде и учитавања Sphinx документације после сваког извршавања.
Linux kernel
Подсистем документације за Linux kernel подвргнут је променама у 2016. години.
Почевши од циклуса 4.7, за документацију се почео употребљавати Sphinx.[6]
- Говор на LCA2016: What I've learned as the kernel docs maintainer
- Говор на LCA2017: Kernel documentation: what we have and where it's going
Види још
[уреди | уреди извор]Референце
[уреди | уреди извор]- ^ 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, стр. 207—215, ISBN 978-1-4302-2757-1, Приступљено 2020-06-26
- ^ Blender Overview, Apress, 2009, стр. 1—23, ISBN 978-1-4302-1976-7, Приступљено 2020-06-26
- ^ Conlan, Chris (2017), The Blender Interface, Apress, стр. 1—9, ISBN 978-1-4842-2801-2, Приступљено 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. Приступљено 2020-06-26.