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

    uRPC умеет генерировать документацию в двух форматах: Textile и Sphinx

    Textile

    Описание

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

    Инструкция по сборке

    Содержимое созданных этим генератором файлов можно напрямую вставлять во все предназанченные для Textile текстовые поля Redmine(wiki, тексты сообщений, новости и т.д.).

    Sphinx

    Описание

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

    Инструкция по сборке

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