db2qthelp — a DocBook book to QtHelp project converter

Introduction

db2qthelp converts a DocBook book to a QtHelp project. It is written in Python and started on the command line.

db2qthelp is in an early stage of development. It works well for me but it may work with my setup only. I try to make it usable nonetheless, so let me know if something does not work. Thanks.

Usage

Given that your xsltproc together with your DocBook look-up paths are set up and that the Qt applications needed to build Qt Help files are in your executable path, you may convert your DocBook book into Qt Help files like this:

db2qthelp.py -i userdocs.xml

That's all 😃. You'll get a .qch and a .qhc file you may use directly in your Qt Help widget…

Documentation

The documentation consists of a user manual and a man-page like call documentation.

If you want to contribute, you may check the API documentation or visit db2qthelp on github where besides the code you may find the db2qthelp issue tracker or a discussions about db2qthelp section.

Additional documentation includes a page with relevant links or the ChangeLog. You may find the complete documentation at the db2qthelp readthedocs pages.

Installation

The current version is 0.4.0. You may install the latest release using pip:

python -m pip install db2qthelp

Or download the latest release from github. You may as well clone or download the db2qthelp git repository. There is also a page about installing db2qthelp which lists further options.

License

db2qthelp is licensed under the GPLv3 license.

Background

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.

Status & Contributing

db2qthelp is in an early development stage. Yet, it is not my major project, so extensions and new versions may take some time. If you need something or have a comment, you may drop me a mail or add an issue.