Сфінкс інструмент, який дозволяє легко створювати, розумний і красивий документації для Python проектів (або інших документів, що складаються з декількох джерел ReStructuredText), написана Георг Брандл. Спочатку проект був створений, щоб перевести нову документацію Пітона, але тепер були очищені в надії, що вона буде корисна для багатьох інших проектів.
Сфінкс використовує ReStructuredText в якості мови розмітки, і багато хто з її сильних сторін прийти від влади і прямолінійність ReStructuredText і його розбору і перекладу люкс, в Docutils.
Хоча це все ще в процесі постійного розвитку, такі функції вже присутні, відмінно працює і можна побачити "в дії" в Python Docs:
І NBSP; * Вихідні формати: HTML (у тому числі Windows, HTML Help) і латексу, для друкованих версій PDF
І NBSP; * велика кількість перехресних посилань: семантична розмітка і автоматичні посилання для функцій, класів, Глосарій термінів і аналогічних частин інформації
І NBSP; * Ієрархічна структура: легкий визначення дерева документа, з автоматичними посилання на братів і сестер, батьків і дітей
І NBSP; * Автоматичне показники: загальний індекс, а також індекс модуль
І NBSP; * код обробки: автоматичне підсвічування за допомогою маркера Pygments
І NBSP; * Різні модулі доступні, наприклад, . Для автоматичного тестування уривків і включення відповідно відформатованих рядків документації
Вимоги
- Python
Коментар не знайдено