Qt Documentation: Project Structure

Documentation Structure

This page is part of the Qt Writing Guidelines.

Qt’s Reference Documentation consists of:

• API Documentation
• Overviews
• Examples

Modularized Documentation

The idea behind modularized documentation is that the documentation for the modules reside with the source code. As a result, moving a module will also move the documentation.

Here is the basic structure, taking the qt5/qtbase directory as an example:

Snippet and Example Relative Paths

QDoc uses the qdocconf [doc-snapshot.qt.io] file to retrieve examples, snippets, and the source code.
In particular, the exampledirs variable holds the paths to the examples and snippets. The \example and \snippet commands’ arguments are relative paths that point to the snippet file or example directory.

Using Qt SQL’s qdocconf file as an example:

This would allow the documentation to use:
Note that qdoc assumes that there are doc/src, doc/images, and doc/snippets directories in each example.

Overview documentation

Some documentation encompasses several modules. This can be demos and overview documentation and tutorials for example.
These should be in the qdoc repository which contains documentation that should be built last.