pugixml.qch QtHelp file for QtAssistant

[GoogleCodeExporter]

- What feature do you require in pugixml?
I would like to have the documentation of pugixml as compressed help file 
(*.qch) 

- What do you need this feature for?
This file can be loaded by QtAssistant or QtCreator to access the documentation 
of pugixml directly from within the development environment.

I have found it to be extremely simple to create a *.qch file from the already 
existing html help files. I've created the file "pugixml.qhp" (attached). Put 
this file into the "docs" folder and run the command "qhelpgenerator.exe 
pugixml.chp -o pugixml.qch". This will create the compressed help file.

I am not familiar with the documentation-build process of pugixml, but IMHO it 
would be the best to include this into the "normal" build process of pugixml 
documentation.

Todo:
- The index is currently rather empty ("pugi" is the only tracked word) as the 
*.qhp file is manually created. Ideally the index should be created directly 
with the doctools.

Original issue reported on code.google.com by tagebuch...@gmail.com on 4 Jul 2014 at 1:51

Attachments:

• pugixml.qhp

[GoogleCodeExporter]

I don't think maintaining a Qt-specific help file is a good idea. The 
documentation process is automatic (and a bit magical...) and while it's 
possible to incorporate Qt documentation building (probably), there could be 
value in also doing it for CHM and/or PDF and it's unclear why Qt should be 
preferable.

I think for now keeping only HTML makes sense; of course you're free to 
maintain the Qt-specific documentation (especially if it's easy to build).

Original comment by arseny.k...@gmail.com on 26 Oct 2014 at 9:03

• Changed state: WontFix