Heyho! I need to do a short evaluation of various documentation tools, preferably OSS ones. I've met sphinx in the TurboGears project, and I think it *might* more or less fit, although it's a bit too techy for our needs. Your comments appreciated. [ even more so if they reach me as cc:'s, though I'll try to remember looking in the list archive. ]
((( perhaps a more or less up to date comparison of such tools exists already? Pointers welcome. ))) We need to produce end user documentation of our software in paper and some kind of HTML snippets for online help. The full online version that Sphinx will produce "for free" is also appreciated. The part where we're struggling (and why we don't want to continue with plain oo.org documents): * brands (we have OEMs, so we need to produce different versions with the different names of the product and with different screenshots. From what I see I should be able to do this with reST Substitutions, right? Screenshots would probably be just as different directories and a clever build script.) * translations (ideally we would be able to track which parts of a document -- as include files? -- are out of date in which translation.) * changes (we work with svn, so we can track changes as is; perhaps somebody even has written some kind of "change bars" extension? This is not mandatory.) The paper version will have some significance, so basic control of page layout is good, but it sholdn't be overrated; the PDF of sphinx' own manual looks just fine. And it will need to be multi-platform. We're a mostly Linux company, but our partners will need to (efficiently) edit text on Windows. What editors do you suggest? And how complicated is it to install the necessary parts for building sphinx documents on Windows? (I think we can live with 'only html' and omit the TeX/PDF toolchain.) A propos Tools: * we'll also need to export the current documentation into the new format. Are there tools to produce reST from opendocument text documents? How
signature.asc
Description: This is a digitally signed message part.
