Документация для open-source проекта

Рейтинг: 3Ответов: 2Опубликовано: 28.09.2014

Привет всем!

Написал небольшую библиотеку на PHP. Теперь встал вопрос о создании сайта для нее. Сайт я решил делать с использованием Yii Framework. Ну и само собой разумеется, что на сайте должна быть документация по работе с этой библиотекой: использование, написание плагинов и прочее.

Вот хотел узнать, есть ли какие-нибудь готовые удобные системы по ведению документации. Основные требования - это:

  • хранение всей документации в базе данных, а не в статичных HTML-файлах;
  • наличие веток или версионности. Например, есть документация для версии библиотеки 1.0. Но в версии 1.1 добавились некоторые возможности, которых нет в 1.0. Мне бы хотелось не делать копию всей документации, а выбирать статьи, которые относятся только к определенным версиям;
  • мультиязычность. Причем желательно, чтобы каждая отдельная статья, а не вся документация, имела разные переводы. Чтобы в случае отсутствия перевода, показывать оригинал статьи;
  • подсветка или простое выделение кода.

Заранее спасибо.

P.S. В общем-то, все мои требования отражены на самом сайте Yii: Только, как я понимаю, отдельных модулей и их исходников для создания такой документации самому нигде нет.

UPD:

Я думал, что таких систем видимо-невидимо в инете должно быть. А начал искать - не нашел. Может, у них какое-то название есть специальное и я не так ищу?

Ответы

▲ 2

Better late than never

http://readthedocs.org/

  • + Версионность
  • + Многоязычность
  • + Автобилд
  • - Все располагается на чужих серверах, можно забрать себе проект с github, но там вряд ли будет подробнейшая документация по поддержке своего сервера
  • + Можно тарнслировать на своем сайте с помощью простого DNS
  • + Подсветка кода
  • + Поиск
▲ 1

https://ru.wikipedia.org/wiki/PhpDocumentor - это отличный инструмент.

Он позволит Вам и документацию вести, и подсказки для IDE будут генерироваться, и поддержка версий есть.