Manuals & Docbook files
Prev
Next

Chapter 3. Manuals & Docbook files

Docbook is an XML based file format for writing manuals and books. More information about using Docbook to write manuals and documentation using Docbook is here. Manuals are written in the Docbook format, but need to be converted into HTML when installed and made available for the KDE Help Center.

Docbooks files and images are usually organised under a doc directory which is then further divided by two letter language code. For example doc/en, doc/nl, en doc/fr. The Docbook files themselves are named index.docbook

By using the docbooks argument to setup() in your setup.py, you can specify the directories containing docbook files. You also need to specify the language used in that directory.

    docbooks = [ ('doc/en','en'), ('doc/nl','nl'), ('doc/fr','fr') ]
The argument to docbooks is a list of tuples. The first item of a tuple is the relative path to a docbook directory. The second item is the two letter language code.

Docbook files specified this way will automatically be converted to HTML during install.

Prev
Next
Home