__init__(app) |
|
build(docnames[, summary, method]) |
Main build method. |
build_all() |
Build all source files. |
build_specific(filenames) |
Only rebuild as much as needed for changes in the filenames. |
build_update() |
Only rebuild what was changed or added since last build. |
cleanup() |
Cleanup any resources. |
compile_all_catalogs() |
|
compile_catalogs(catalogs, message) |
|
compile_specific_catalogs(specified_files) |
|
compile_update_catalogs() |
|
create_template_bridge() |
Return the template bridge configured. |
finish() |
Finish the building process. |
get_builder_config(option, default) |
Return a builder specific option. |
get_outdated_docs() |
Return an iterable of output files that are outdated, or a string describing what an update build will build. |
get_relative_uri(from_, to[, typ]) |
Return a relative URI between two source filenames. |
get_target_uri(docname[, typ]) |
Return the target URI for a document name. |
init() |
Load necessary templates and perform initialization. |
post_process_images(doctree) |
Pick the best candidate for all image URIs. |
prepare_writing(docnames) |
A place where you can add logic before write_doc() is run |
write(build_docnames, updated_docnames[, method]) |
|
write_doc(docname, doctree) |
Where you actually write something to the filesystem. |
write_doc_serialized(docname, doctree) |
Handle parts of write_doc that must be called in the main process if parallel build is active. |