itcase-sphinx-theme-example
  • Что такое reStructuredText?
  • Базовые концепции
  • Абзацы
  • Заголовки
  • Начертание
  • Нумерованные списки
  • Маркированные списки
  • Вложенные списки
  • Верхний и нижние индексы
  • Определения
  • Цитаты
  • Эпиграф
  • Сноски
  • Комментарии
  • Листинги (исходный код)
  • Автозамены (Подстановки)
  • Использование символов юникод (unicode)
  • Дата и время
  • Вставка текста из других файлов
  • Черта (Линия)
  • Ссылки
  • Изображения и иллюстрации
  • Таблицы
  • Формулы
  • Блоки примечаний и предупреждений
  • Содержание
  • Метаданные. Тег META
  • API
  • Application API
Quick search
Enter search terms or a module, class or function name.
 
 
itcase-sphinx-theme-example  
Генератор документации Sphinx
 Edit on GitHub

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

В руководстве подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs.

  • Что такое reStructuredText?
  • Базовые концепции
  • Абзацы
  • Заголовки
  • Начертание
  • Нумерованные списки
  • Маркированные списки
  • Вложенные списки
  • Верхний и нижние индексы
  • Определения
  • Цитаты
  • Эпиграф
  • Сноски
  • Комментарии
  • Листинги (исходный код)
    • Python
    • bash
    • C++
    • JavaScript
    • Jinja2
    • Golang
    • JSON
    • long string
  • Автозамены (Подстановки)
  • Использование символов юникод (unicode)
  • Дата и время
  • Вставка текста из других файлов
  • Черта (Линия)
  • Ссылки
  • Изображения и иллюстрации
  • Таблицы
  • Формулы
  • Блоки примечаний и предупреждений
  • Содержание
  • Метаданные. Тег META
  • API
    • Domain API
    • Build environment API
    • Docutils markup API
  • Application API
    • Extension setup
    • Emitting events
    • Producing messages / logging
    • Sphinx core events
    • Checking the Sphinx version
    • The Config object
    • The template bridge
    • Exceptions

Note

Последняя правка: Oct 05, 2017

Next  
© Copyright 2017, ITCase.
ITCase Sphinx Theme | version: 0.3.1