Генератор документации Sphinx
В руководстве подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs.
Примечание
Последняя правка: 26/03/2024 в 15:29
- Предисловие
- Генератор документации Sphinx
- Стандартный синтаксис разметки reStructuredText
- Что такое reStructuredText?
- Редакторы reStructuredText
- Синтаксис reStructuredText
- Базовые концепции
- Абзацы
- Заголовки
- Начертание
- Нумерованные списки
- Маркированные списки
- Вложенные списки
- Верхний и нижние индексы
- Определения
- Цитаты
- Эпиграф
- Сноски
- Комментарии
- Листинги (исходный код)
- Автозамены (Подстановки)
- Использование символов юникод (unicode)
- Дата и время
- Вставка текста из других файлов
- Черта (Линия)
- Ссылки
- Изображения и иллюстрации
- Таблицы
- Формулы
- Блоки примечаний и предупреждений
- Содержание
- Метаданные. Тег META
- Конструкции разметки Sphinx
- Система управления версиями Git
- Установка Git
- Первичная настройка
- Основные команды
- Получение справки
- Создание репозитория в существующем каталоге
- Клонирование существующего репозитория
- Определение состояния файлов
- Отслеживание новых файлов
- Игнорирование файлов
- Просмотр индексированных и неиндексированных изменений
- Фиксация изменений
- Игнорирование индексации
- Удаление файлов
- Перемещение файлов
- Просмотр истории коммитов
- Изменение последнего коммита
- Отмена индексации файла
- Отмена изменений файла
- Просмотр меток (тегов)
- Создание легковесных меток(тегов)
- Создание аннотированных меток(тегов)
- Выставление меток(тегов) позже
- Обмен метками(тегами)
- Удаление меток(тегов)
- Отображение удалённых репозиториев
- Добавление удалённых репозиториев
- Извлечение данных из удаленного репозитория
- Отправка данных в удаленный репозиторий
- Инспекция удалённого репозитория
- Удаление и переименование удалённых репозиториев
- Создание новой ветки
- Переход на другую ветку
- Слияние веток
- Удаление ветки
- Состояние веток
- Перемещение изменений между ветками
- Отслеживание веток
- Удаление веток на удалённом сервере
- Прятанье
- GitHub и Read The Docs
- Известные проблемы
- Часто задаваемые вопросы
- Как добавить подпись к рисунку?
- Как добавить подпись к таблице?
- Как сделать ссылку на главу или раздел?
- Как вставить содержание в разделе (документе)?
- Как сделать перекрестную ссылку на таблицу или рисунок?
- Как сделать перекрестную ссылку в виде категории?
- Вставка графиков
- Как настроить автоматическую генерацию документации
- Как сделать принудительный разрыв строки?
- Есть более быстрый способ делать таблицы?
- Соглашения
- Приложение I – Установка и настройка Python Sphinx в ОС Windows