sphinx.builders.singlehtml.SingleFileHTMLBuilder

class documentation

class SingleFileHTMLBuilder(StandaloneHTMLBuilder): (source)

View In Hierarchy

A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.

Method assemble_doctree Undocumented
Method assemble_toc_fignumbers Undocumented
Method assemble_toc_secnumbers Undocumented
Method finish Finish the building process.
Method fix_refuris Undocumented
Method get_doc_context Collect items for the template context of a page.
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_relative_uri Return a relative URI between two source filenames.
Method get_target_uri Return the target URI for a document name.
Method write Undocumented
Method write_additional_files Undocumented
Class Variable copysource Undocumented
Class Variable epilog Undocumented
Class Variable name Undocumented
Method _get_local_toctree Undocumented

Inherited from StandaloneHTMLBuilder:

Method __init__ Undocumented
Method add_css_file Undocumented
Method add_js_file Undocumented
Method add_sidebars Undocumented
Method cleanup Cleanup any resources.
Method copy_download_files Undocumented
Method copy_extra_files copy html_extra_path files.
Method copy_html_favicon Undocumented
Method copy_html_logo Undocumented
Method copy_html_static_files Undocumented
Method copy_image_files Undocumented
Method copy_static_files Undocumented
Method copy_stemmer_js Copy a JavaScript file for stemmer.
Method copy_theme_static_files Undocumented
Method copy_translation_js Copy a JavaScript file for translations.
Method create_build_info Undocumented
Method create_pygments_style_file create a style file for pygments.
Method dump_inventory Undocumented
Method dump_search_index Undocumented
Method gen_additional_pages Undocumented
Method gen_indices Undocumented
Method gen_pages_from_extensions Undocumented
Method get_asset_paths Return list of paths for assets (ex. templates, CSS, etc.).
Method get_outfilename Undocumented
Method get_theme_config Undocumented
Method handle_finish Undocumented
Method handle_page Undocumented
Method index_page Undocumented
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method init_css_files Undocumented
Method init_highlighter Undocumented
Method init_js_files Undocumented
Method init_templates Undocumented
Method load_indexer Undocumented
Method post_process_images Pick the best candidate for an image and link down-scaled images to their high res version.
Method prepare_writing A place where you can add logic before :meth:`write_doc` is run
Method render_partial Utility: Render a lone doctree node.
Method update_page_context Undocumented
Method write_buildinfo Undocumented
Method write_doc Where you actually write something to the filesystem.
Method write_doc_serialized Handle parts of write_doc that must be called in the main process if parallel build is active.
Method write_domain_indices Undocumented
Method write_genindex Undocumented
Class Variable add_permalinks Undocumented
Class Variable allow_parallel Undocumented
Class Variable allow_sharp_as_current_path Undocumented
Class Variable download_support Undocumented
Class Variable embedded Undocumented
Class Variable format Undocumented
Class Variable html_scaled_image_link Undocumented
Class Variable indexer_dumps_unicode Undocumented
Class Variable search Undocumented
Class Variable searchindex_filename Undocumented
Class Variable supported_data_uri_images Undocumented
Class Variable supported_image_types Undocumented
Class Variable supported_remote_images Undocumented
Instance Variable build_info Undocumented
Instance Variable css_files Undocumented
Instance Variable current_docname Undocumented
Instance Variable dark_highlighter Undocumented
Instance Variable dlpath Undocumented
Instance Variable docsettings Undocumented
Instance Variable docwriter Undocumented
Instance Variable domain_indices Undocumented
Instance Variable fignumbers Undocumented
Instance Variable globalcontext Undocumented
Instance Variable highlighter Undocumented
Instance Variable imagedir Undocumented
Instance Variable imgpath Undocumented
Instance Variable indexer Undocumented
Instance Variable last_updated Undocumented
Instance Variable link_suffix Undocumented
Instance Variable out_suffix Undocumented
Instance Variable relations Undocumented
Instance Variable script_files Undocumented
Instance Variable secnumbers Undocumented
Instance Variable theme Undocumented
Instance Variable theme_options Undocumented
Instance Variable use_index Undocumented
Property default_translator_class Undocumented
Property math_renderer_name Undocumented
Method _get_style_filenames Undocumented
Method _get_translations_js Undocumented
Instance Variable _css_files Undocumented
Instance Variable _publisher Undocumented
Instance Variable _script_files Undocumented

Inherited from Builder (via StandaloneHTMLBuilder):

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 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_builder_config Return a builder specific option.
Method get_translator_class Return a class of translator.
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_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 events Undocumented
Instance Variable finish_tasks Undocumented
Instance Variable images Undocumented
Instance Variable outdir Undocumented
Instance Variable parallel_ok Undocumented
Instance Variable srcdir Undocumented
Instance Variable tags Undocumented
Instance Variable templates Undocumented
Method _read_parallel Undocumented
Method _read_serial Undocumented
Method _write_parallel Undocumented
Method _write_serial Undocumented
def assemble_doctree(self): (source)

Undocumented

Returns
nodes.documentUndocumented
def assemble_toc_fignumbers(self): (source)

Undocumented

Returns
dict[str, dict[str, dict[str, tuple[int, ...]]]]Undocumented
def assemble_toc_secnumbers(self): (source)

Undocumented

Returns
dict[str, dict[str, tuple[int, ...]]]Undocumented
def finish(self): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.finish

Finish the building process. The default implementation does nothing.

def fix_refuris(self, tree): (source)

Undocumented

Parameters
tree:NodeUndocumented
def get_doc_context(self, docname, body, metatags): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.get_doc_context

Collect items for the template context of a page.

Parameters
docname:strUndocumented
body:strUndocumented
metatags:strUndocumented
Returns
dict[str, Any]Undocumented
def get_outdated_docs(self): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.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
str|list[str]Undocumented
def get_relative_uri(self, from_, to, typ=None): (source)
overrides sphinx.builders.Builder.get_relative_uri

Return a relative URI between two source filenames. May raise environment.NoUri if there's no way to return a sensible URI.

Parameters
from_:strUndocumented
to:strUndocumented
typ:str|NoneUndocumented
Returns
strUndocumented
def get_target_uri(self, docname, typ=None): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.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 write(self, *ignored): (source)
overrides sphinx.builders.Builder.write

Undocumented

Parameters
*ignored:AnyUndocumented
@progress_message(__('writing additional files'))
def write_additional_files(self): (source)

Undocumented

copysource: bool = (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.copysource

Undocumented

epilog = (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.epilog

Undocumented

name: str = (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.name

Undocumented

def _get_local_toctree(self, docname, collapse=True, **kwargs): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder._get_local_toctree

Undocumented

Parameters
docname:strUndocumented
collapse:boolUndocumented
**kwargs:AnyUndocumented
Returns
strUndocumented