sphinx.builders.gettext.I18nBuilder

class documentation

class I18nBuilder(Builder): (source)

Known subclasses: sphinx.builders.gettext.MessageCatalogBuilder

View In Hierarchy

General i18n builder.

Method compile_catalogs Undocumented
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 :meth:`write_doc` is run
Method write_doc Where you actually write something to the filesystem.
Class Variable name Undocumented
Class Variable use_message_catalog Undocumented
Class Variable versioning_method Undocumented
Instance Variable catalogs Undocumented
Instance Variable tags Undocumented

Inherited from Builder:

Method __init__ Undocumented
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 cleanup Cleanup any resources.
Method compile_all_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 finish Finish the building process.
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_relative_uri Return a relative URI between two source filenames.
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 allow_parallel Undocumented
Class Variable default_translator_class Undocumented
Class Variable epilog Undocumented
Class Variable format Undocumented
Class Variable supported_data_uri_images Undocumented
Class Variable supported_image_types Undocumented
Class Variable supported_remote_images Undocumented
Class Variable versioning_compare Undocumented
Instance Variable app Undocumented
Instance Variable confdir Undocumented
Instance Variable config Undocumented
Instance Variable doctreedir Undocumented
Instance Variable env Undocumented
Instance Variable events 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 templates Undocumented
Method _read_parallel Undocumented
Method _read_serial Undocumented
Method _write_parallel Undocumented
Method _write_serial Undocumented
def compile_catalogs(self, catalogs, message): (source)
overrides sphinx.builders.Builder.compile_catalogs

Undocumented

Parameters
catalogs:set[CatalogInfo]Undocumented
message:strUndocumented
def get_outdated_docs(self): (source)
overrides sphinx.builders.Builder.get_outdated_docs

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
set[str]Undocumented
def get_target_uri(self, docname, typ=None): (source)
overrides sphinx.builders.Builder.get_target_uri

Return the target URI for a document name. *typ* can be used to qualify the link characteristic for individual builders.

Parameters
docname:strUndocumented
typ:str|NoneUndocumented
Returns
strUndocumented
def init(self): (source)
overrides sphinx.builders.Builder.init
overridden in sphinx.builders.gettext.MessageCatalogBuilder

Load necessary templates and perform initialization. The default implementation does nothing.

def prepare_writing(self, docnames): (source)
overrides sphinx.builders.Builder.prepare_writing

A place where you can add logic before :meth:`write_doc` is run

Parameters
docnames:set[str]Undocumented
def write_doc(self, docname, doctree): (source)
overrides sphinx.builders.Builder.write_doc

Where you actually write something to the filesystem.

Parameters
docname:strUndocumented
doctree:nodes.documentUndocumented
name: str = (source)
overrides sphinx.builders.Builder.name
overridden in sphinx.builders.gettext.MessageCatalogBuilder

Undocumented

use_message_catalog: bool = (source)
overrides sphinx.builders.Builder.use_message_catalog

Undocumented

versioning_method: str = (source)
overrides sphinx.builders.Builder.versioning_method

Undocumented

catalogs: defaultdict[str, Catalog] = (source)

Undocumented

tags = (source)
overrides sphinx.builders.Builder.tags

Undocumented