Generate Qt help documentation
Qt Help documentation is generated as a Qt compressed help (QCH) file, designed for integration with applications built on the Qt framework. It provides searchable, structured help content that can be embedded directly into Qt-based software.
HelpNDoc can generate Qt Help documentation directly from your project. The generation process can be performed quickly using the default settings, or with advanced configuration options through the documentation generation dialog.
Quick Qt Help generation
To quickly generate Qt Help documentation using the current project settings:
- Go to the Home ribbon tab.
- Click the bottom part of the Generate Help button.
- Select Qt Help Documentation from the available output formats.
This will immediately create a Qt Help file using the predefined settings for the project.
Advanced generation options
If you need more control over the Qt Help output:
- Go to the Home ribbon tab.
- Click the top part of the Generate Help button.
- In the Generate Documentation dialog, make sure that Build Qt Help Documentation is checked in the build list.
From here, you can adjust generation settings such as output location, template, or options specific to the Qt Help format. See: Customize Qt help documentation settings