Sphinx jest narzędziem, które pozwala łatwo tworzyć inteligentne i piękne dokumentacji projektów Pythona (lub innych dokumentów składających się z wielu źródeł reStructuredText), napisana przez Georga Brandla. Projekt został stworzony, aby przetłumaczyć nowej dokumentacji Pythona, ale został oczyszczony w nadziei, że będzie użyteczny dla wielu innych projektów.
Sfinks wykorzystuje reStructuredText jako język znaczników, a wiele z jego mocnych pochodzą z mocą i prostolinijność z reStructuredText i jej analizowania i tłumaczenia apartamencie, w Docutils.
Mimo że jest jeszcze w ciągłym rozwoju, następujące funkcje są już obecne, działa dobrze i można zobaczyć "w akcji" w docs Pythona:
& Nbsp; * Formaty wyjściowe: HTML (w tym HTML Help) i LaTeX-a, do druku wersji PDF
& Nbsp; * Rozbudowane odsyłacze: znacznikiem semantycznym i automatyczne linki do funkcji, klas, w słowniku i podobnych elementów informacji
& Nbsp; * Hierarchiczna struktura: łatwa definicja drzewa dokumentu, automatyczne linki do rodzeństwa, rodziców i dzieci
& Nbsp; * indeksy Automatyczne: Ogólny indeks oraz spis Moduł
& Nbsp; * obsługa Kod: automatyczne podświetlenie za pomocą wyróżnienia Pygments
& Nbsp; * dostępne są różne rozszerzenia, np . do automatycznego testowania i integracji fragmentów odpowiednio sformatowanych docstrings
Wymagania :
- Python
Komentarze nie znaleziono