Руководство по работе с генератором документации Sphinx¶

Предупреждение

Раздел в разработке.

Работа с генератором документации Sphinx¶

Параграфы¶

Параграфы в reStructuredText разделяются пустой строкой, в то время как единичный перевод
строки можно использовать для повышения читаемости исходного текста документации.

В данном мы примере текстовой разметки, мы решили ограничить себя длинной строки
в 100 символов. Благодаря такому ограничению, текстовую разметку удобно читать и на мониторах
с небольшим разрешением экрана.

Заголовки¶

Заголовки в reStructuredText состоят из двух идущих подряд строк: первая строка – текст заголовка, вторая строка – повторяющийся спецсимвол.

Так как проект русскоязычный, рекомендуется задавать заголовки с помощью спецсимволов, доступных на русской раскладке клавиатуры:

===================
Первичный заголовок
===================

Вторичный заголовок
===================

Третичный заголовок
-------------------

Четвертичный заголовок
""""""""""""""""""""""

Пятичный заголовок
::::::::::::::::::

Шестичный заголовок
*******************

Семичный заголовок
++++++++++++++++++

Сборка проекта¶

С помощью команды make¶

В формате HTML:

make html

В простом формате PDF:

make pdf

В формате LaTeX:

make latex

В формате PDF на основе LaTeX:

make latexpdf

См. так же¶

Неофициальное руководство на русском языке:

Генератор документации Sphinx.

Официальная документация на английском языке: