Any good documentation generators?

For the generic offtopic chit-chat
Post Reply
Dayman

Any good documentation generators?

Post by Dayman »

I think the documentation question has been raised a couple of times already. qBittorrent could benefit from having documentation (or at least options description) a lot.

And so I'm looking for documentation generators. The end-user documentation, so Doxygen won't do.
The only thing I can think of is Qt Help system, which can be integrated quiet well.

Maintaining documentation in Wiki is ok, but will be incompatible with older versions.

Requirements are:
  1. Can generate documentation from command line
  2. Multi-platform (at least Win/Unix/Mac) support
  3. TOC (Table of Contents) autogeneration
  4. Preferable output type (one of):
    • Single HTML
    • Standard-compliant PDF
    • Binary (like QtHelp; it actually uses sqlite3 database btw)
    [/li]
  5. Input files can be easily put under vcs (aka 'input files are text files')
  6. Do not require a lot of fancy stuff at runtime (like perl or python)

I currently have 3 candidates: AsciiDoc, Sphinx and markdown. Can't find any good sources on Qt documentation markup, will need to examine end-user documentation sources for designer/assistant/creator to see what it's made of.
Last edited by Dayman on Sun Jan 13, 2013 9:22 pm, edited 1 time in total.
Post Reply