class documentation

class XMLBuilder(Builder):

Known subclasses: sphinx.builders.xml.PseudoXMLBuilder

View In Hierarchy

Builds Docutils-native XML.
Class Variable format Undocumented
Class Variable name Undocumented
Method finish Finish the building process.
Method get​_outdated​_docs Return an iterable of output files that are outdated, or a string describing what an update build will build.
Method get​_target​_uri Return the target URI for a document name.
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method prepare​_writing A place where you can add logic before write_doc is run
Method write​_doc Where you actually write something to the filesystem.
Class Variable allow​_parallel Undocumented
Class Variable epilog Undocumented
Class Variable out​_suffix Undocumented
Instance Variable writer Undocumented

Inherited from Builder:

Method build Main build method.
Method build​_all Build all source files.
Method build​_specific Only rebuild as much as needed for changes in the filenames.
Method build​_update Only rebuild what was changed or added since last build.
Method get​_relative​_uri Return a relative URI between two source filenames.
Class Variable default​_translator​_class Undocumented
Class Variable supported​_data​_uri​_images Undocumented
Class Variable supported​_image​_types Undocumented
Class Variable supported​_remote​_images Undocumented
Instance Variable events Undocumented
Method __init__ Undocumented
Method ​_read​_parallel Undocumented
Method ​_read​_serial Undocumented
Method ​_write​_parallel Undocumented
Method ​_write​_serial Undocumented
Method cleanup Cleanup any resources.
Method compile​_all​_catalogs Undocumented
Method compile​_catalogs Undocumented
Method compile​_specific​_catalogs Undocumented
Method compile​_update​_catalogs Undocumented
Method create​_template​_bridge Return the template bridge configured.
Method create​_translator Return an instance of translator.
Method get​_asset​_paths Return list of paths for assets (ex. templates, CSS, etc.).
Method get​_builder​_config Return a builder specific option.
Method get​_translator​_class Return a class of translator.
Method post​_process​_images Pick the best candidate for all image URIs.
Method read (Re-)read all files new or changed since last update.
Method read​_doc Parse a file and add/update inventory entries for the doctree.
Method set​_environment Store BuildEnvironment object.
Method write Undocumented
Method write​_doc​_serialized Handle parts of write_doc that must be called in the main process if parallel build is active.
Method write​_doctree Write the doctree to a file.
Class Variable use​_message​_catalog Undocumented
Class Variable versioning​_compare Undocumented
Class Variable versioning​_method Undocumented
Instance Variable app Undocumented
Instance Variable confdir Undocumented
Instance Variable config Undocumented
Instance Variable doctreedir Undocumented
Instance Variable env Undocumented
Instance Variable finish​_tasks Undocumented
Instance Variable imagedir Undocumented
Instance Variable images Undocumented
Instance Variable imgpath Undocumented
Instance Variable outdir Undocumented
Instance Variable parallel​_ok Undocumented
Instance Variable srcdir Undocumented
Instance Variable tags Undocumented
Instance Variable templates Undocumented
format: str =
name: str =
def finish(self):

Finish the building process.

The default implementation does nothing.

def get_outdated_docs(self):

Return an iterable of output files that are outdated, or a string describing what an update build will build.

If the builder does not output individual files corresponding to source files, return a string here. If it does, return an iterable of those files that need to be written.

Returns
Iterator[str]Undocumented
def get_target_uri(self, docname, typ=None):

Return the target URI for a document name.

typ can be used to qualify the link characteristic for individual builders.

Parameters
docname:strUndocumented
typ:strUndocumented
Returns
strUndocumented
def init(self):
Load necessary templates and perform initialization. The default implementation does nothing.
def prepare_writing(self, docnames):
A place where you can add logic before write_doc is run
Parameters
docnames:Set[str]Undocumented
def write_doc(self, docname, doctree):
Where you actually write something to the filesystem.
Parameters
docname:strUndocumented
doctree:NodeUndocumented
allow_parallel: bool =
epilog =
out_suffix: str =

Undocumented

writer =

Undocumented