• Есть насущная потребность в написании документации по API. Нужен какой-то инструмент. Но проблема в том, что не только по API, но вообще референс про разнообразное: гаедлайны, методики, примеры и так далее. Всё это должно в одном документе быть. Естественно, в исходном виде должно быть нечто текстовое, легко редактируемое и расширяемое. На выходе — pdf/html/etc. Docbook как-то не нравится, очень уж он избыточен и ебанут, править xml напрямую нет желания, а использовать редакторы не получится, так как уже есть несколько критичных фич, которые туда не влезают (разнообразные таблично-подобные штуки).

    Пока присматриваюсь к Sphinx, вроде бы подходит, но нужно смотреть.

Replies (4)

  • @cancel, LaTeX, может? В PDF компилится, в HTML — конвертится (tex4ht хотя бы, он из DVI конвертит, следовательно, все выкрутасы поймет, какие в исходнике наворотишь). CHM я вот не умею автоматически из него делать, но CHM богопротивен, и я бы с удовольствием его вообще не делал никогда в жизни. В ODF теоретически тем же tex4ht сливается, но тут я тыкнулся под виндой, а там надо что-то доустанавливать, а это влом.

    Пакет listings исходники раскрашивать умеет.
  • @cancel, @trminator латех — это вторичный формат. Он семантически неструктурированный по умолчанию, а городить собственный стиль нет желания.
  • @cancel, @infidel Не подходит, все web-based системы сразу идут лесом. Нужен простой текстовый формат, который собирается при необходимости в нужный выходной формат. Лучше Sphinx я пока не нарыл, пока осваиваю.