Skip to main content

A DocBook book to QtHelp converter

Project description

License: BSD PyPI version Downloads

db2qthelp — a DocBook book to QtHelp project converter


db2qthelp converts a DocBook book to a QtHelp project.

db2qthelp is in an early stage of "development". It works well for me but it may work with my setup only.

Any feedback is appreciated.


I usually write my user documentation using DocBook. For my recent applications built on top of Qt, I needed something that generates in-app help pages. db2qthelp does this.

Download and Installation

The current version is db2qthelp-0.2.

You may install db2qthelp using

python -m pip install db2qthelp

You may download a copy or fork the code at db2qthelp's github page.

Besides, you may download the current release here:


db2qthelp is licensed under the BSD license.



db2qthelp is implemented in Python. It is started on the command line.

db2qthelp parses a single-file HTML representation of a DocBook book. If you have a DocBook book you have to convert it to a single-file HTML document. The images you use within the book should be located in folders.

As soon as you have converted your DocBook book into a single-file HTML page, you may run db2qthelp to convert it into a QtHelp project.

The option


The script has the following options:

  • --input/-i <PATH>: the file or the folder to process
  • --help: Prints the help screen


db2qthelp -i my_page.html -a quotes.german

Replaces !!!

db2qthelp -i my_folder -r --no-backup

Applies !!!

Further Documentation

Examples / Users

  • PaletteWB — a sophisticated palette editor for MS Windows.

Change Log

Version 0.2

  • Initial checkin
  • Adding configuration options


Well, have fun. If you have any comments / ideas / issues, please submit them to db2qthelp's issue tracker on github.

Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

db2qthelp-0.2.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

db2qthelp-0.2-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page