qidoc.builder - Building documentation

QiBuild

class qidoc.builder.DocBuilder(doc_worktree, base_project_name=None)

Build and install doc projects. Initialize with a base_project, which will be at the root of the dest dir when installed. The install step is required to have redistributable documentation folder, while you can browse the documentation directly from the build dir.

base_project

Base Project

set_base_project(name)

Base Project Setter

configure()

Configure the projects in the right order

build(pdb=False)

Build the projects in the right order, making sure they are configured first.

intl_update()

Regenerate translation catalogs for the top project

install(destdir, clean=False)

Install the doc projects to a dest dir

get_dep_projects()

Get the list of project deps