Сфинкс е инструмент, който го прави лесно да се създаде интелигентна и красива документация за Python проекти (или други документи, съставени от множество източници reStructuredText), написани от Georg Брандл. Първоначално проектът е създаден, за да се преведат на нова Python документация, но вече е почистен, с надеждата, че ще бъде полезна за много други проекти.
Сфинкс използва reStructuredText като своя език за маркиране, и много от нейните силни страни идват от властта и прямотата на reStructuredText и разбор и превода апартамент, на Docutils.
Въпреки че все още е под постоянно развитие, със следните характеристики вече са налице, работи добре и може да се види "в действие" в Docs питона:
& Nbsp; * изходни формати: HTML (включително Windows HTML Help) и LaTeX, за отпечатване на PDF версии
& Nbsp; * Обширна препратки: семантично маркиране и автоматични линкове за функции, класове, с речник термини и подобни парчета информация
& Nbsp; * йерархична структура: лесно дефиниране на документ, дърво, с автоматични връзки към братя и сестри, родители и деца
& Nbsp; * Автоматично индекси: общ индекс, както и индекс на модул
& Nbsp; * боравене Code: автоматично осветяване с помощта на маркера Pygments
& Nbsp; * Различни разширения са на разположение, например . за автоматично тестване на откъси и включване на подходящо форматирани docstrings
<силни> Изисквания :
- Python
Коментари не е намерена