qidoc.sphinx_project - Sphinx projects

QiBuild

class qidoc.sphinx_project. SphinxProject ( doc_worktree , project , name , depends=None , dest=None )

A doc project using Sphinx

source_dir

Source Dir

configure ( **kwargs )

Create a correct conf.py in self.build_dir

append_breathe_settings ( )

Append Breathe Settings

append_qiapidoc_settings ( )

Return a string representing the qiapidoc settings

Return a string representing the doxylink settings

append_intersphinx_settings ( conf , rel_paths=False )

Return a string representing the intersphinx settings

static append_extension ( conf , extension_name )

Append Extension

build ( **kwargs )

Run sphinx.main() with the correct arguments

generate_examples_zips ( )

Generate Exemples ZIPs

intl_update ( )

Intl Update

intl_build ( language )

Intl Build

install ( destdir )

Install

qidoc.sphinx_project. get_num_spellcheck_errors ( build_dir )

Get Num Spellcheck Errors

exception qidoc.sphinx_project. SphinxBuildError

SphinxBuildError Exception

exception qidoc.sphinx_project. UnknownLingua ( project , language )

UnknownLingua Exception