• О проекте
  • Создание проекта
  • Библиотека
  • Документация
  • Прошивка
  • Qt debugger
  • Python
  • C#
  • TANGO
  • Конвертер профилей
  • Документация

    uRPC умеет генерировать документацию в трёх форматах: Markdown, Textile и Sphinx. Каждый из форматов описан ниже.

    Markdown

    Markdown – это облегченный язык разметки, который можно использовать для добавления элементов форматирования в текстовые документы. Познакомиться с синтаксисом языка Markdown и попробовать использовать разметку при вводе текста можно в онлайн-песочнице.

    Textile

    Формат Textile – простой язык разметки, позволяющий пользователям описывать сложные схемы форматирования текстовых документов без использования внешних средств (WYSIWYG-редакторов, TEX, HTML и т.д.). Более подробно о синтаксисе и семантике языка Textile можно узнать в онлайн-песочнице (там же можно и протестировать сгенерированные файлы).

    Sphinx

    Sphinx – это генератор документации, который преобразует файлы в формате reStructuredText в HTML и другие форматы (PDF, EPub и man).

    Архив сгенерированной документацией содержит файл .rst формата документации Sphinx и файл .po формата gettext для перевода документации на русский язык.

    О том, как сделать html-страницу документации Sphinx из этих файлов, можно прочитать на сайте Sphinx.