Author Topic: Any good documentation generators?  (Read 1099 times)

Dayman

  • Administrator
  • Veteran
  • *****
  • Posts: 343
  • Karma: +45/-0
    • View Profile
Any good documentation generators?
« on: January 13, 2013, 06:28:24 pm »
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:
  • Can generate documentation from command line
  • Multi-platform (at least Win/Unix/Mac) support
  • TOC (Table of Contents) autogeneration
  • Preferable output type (one of):
    • Single HTML
    • Standard-compliant PDF
    • Binary (like QtHelp; it actually uses sqlite3 database btw)
  • Input files can be easily put under vcs (aka 'input files are text files')
  • 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 Edit: January 13, 2013, 10:22:38 pm by Dayman »
Building x86_64 stuff on Windows due to Gentoo syndrome.

Jabber: Dayman@dukgo.com
Skype: x.dayman
Irc #qbittorrent@freenode.net: Dayman