qiBuild documentation

qidoc.worktree - qidoc Worktree

QiBuild

class qidoc.worktree.DocWorkTree(worktree)

Stores configuration of doxygen and sphinx projects

template_project

Template Project

reload()

Reload

get_doc_project(name, raises=False)

Get Doc Project

check_unique_name(new_project)

Return a boolean telling if we should add the project to the worktree

qidoc.worktree.new_doc_project(doc_worktree, project)

New Doc Project

exception qidoc.worktree.BadProjectConfig

BadProjectConfig Exception