sphinx-test

Навигация

  • Введение
  • SublimeText
  • Сборка HTML
  • Сборка DOCX
  • Сборка PDF с помощью docx2pdf
  • Сборка PDF с помощью LaTeX
  • Хостинг на Read The Docs

Related Topics

  • Documentation overview
    • Next: Введение

Быстрый поиск

Sphinx и reStructuredText. Учебный проект¶

Цель¶

Познакомиться с Sphinx и reStructuredText.

Задачи¶

  • Создать проект Sphinx для документации на языке разметки reStructuredText.
  • Генерировать документацию в формате HTML.
  • Генерировать документацию в формате PDF.
  • Хранить исходники в Git.
  • Публиковать сайт с документацией на ReadTheDocs.

Содержание¶

  • Введение
    • Установка Sphinx
    • Ссылки
  • SublimeText
    • Установка SublimeText
    • Установка плагинов
    • Плагины
  • Сборка HTML
    • Сайт с несколькими страницами
    • Одностраничный сайт
    • Ссылки на дополнительные материалы
  • Сборка DOCX
    • Подготовка к работе
    • Создание DOCX-файлов
    • Ссылки на дополнительные материалы
  • Сборка PDF с помощью docx2pdf
    • Подготовка к работе
    • Создание PDF-файлов
    • Скрипт для создания PDF-файлов
  • Сборка PDF с помощью LaTeX
    • Подготовка к работе
    • Создание PDF-файлов
    • Ссылки на дополнительные материалы
  • Хостинг на Read The Docs

Indices and tables¶

  • Алфавитный указатель
  • Поиск
©2020, fish-train. | Powered by Sphinx 1.8.5 & Alabaster 0.7.12 | Page source