sphinx.builders.html.StandaloneHTMLBuilder

class documentation

class StandaloneHTMLBuilder(Builder): (source)

Known subclasses: sphinx.builders._epub_base.EpubBuilder, sphinx.builders.dirhtml.DirectoryHTMLBuilder, sphinx.builders.singlehtml.SingleFileHTMLBuilder

View In Hierarchy

Builds standalone HTML docs.

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 finish Finish the building process.
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_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_outfilename Undocumented
Method get_target_uri Return the target URI for a document name.
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 copysource Undocumented
Class Variable download_support Undocumented
Class Variable embedded Undocumented
Class Variable epilog Undocumented
Class Variable format Undocumented
Class Variable html_scaled_image_link Undocumented
Class Variable indexer_dumps_unicode Undocumented
Class Variable name 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_local_toctree 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:

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_relative_uri Return a relative URI between two source filenames.
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 Undocumented
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 __init__(self, app, env=None): (source)
overrides sphinx.builders.Builder.__init__

Undocumented

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
def add_css_file(self, filename, **kwargs): (source)

Undocumented

Parameters
filename:strUndocumented
**kwargs:AnyUndocumented
def add_js_file(self, filename, **kwargs): (source)

Undocumented

Parameters
filename:strUndocumented
**kwargs:AnyUndocumented
def add_sidebars(self, pagename, ctx): (source)

Undocumented

Parameters
pagename:strUndocumented
ctx:dictUndocumented
def cleanup(self): (source)
overrides sphinx.builders.Builder.cleanup

Cleanup any resources. The default implementation does nothing.

def copy_download_files(self): (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

def copy_extra_files(self): (source)

copy html_extra_path files.

def copy_html_favicon(self): (source)

Undocumented

def copy_html_logo(self): (source)

Undocumented

def copy_html_static_files(self, context): (source)

Undocumented

Parameters
context:dictUndocumented
def copy_image_files(self): (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

def copy_static_files(self): (source)

Undocumented

def copy_stemmer_js(self): (source)

Copy a JavaScript file for stemmer.

def copy_theme_static_files(self, context): (source)

Undocumented

Parameters
context:dict[str, Any]Undocumented
def copy_translation_js(self): (source)

Copy a JavaScript file for translations.

def create_build_info(self): (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

Returns
BuildInfoUndocumented
def create_pygments_style_file(self): (source)

create a style file for pygments.

@progress_message(__('dumping object inventory'))
def dump_inventory(self): (source)

Undocumented

def dump_search_index(self): (source)

Undocumented

def finish(self): (source)
overrides sphinx.builders.Builder.finish
overridden in sphinx.builders.singlehtml.SingleFileHTMLBuilder

Finish the building process. The default implementation does nothing.

@progress_message(__('writing additional pages'))
def gen_additional_pages(self): (source)

Undocumented

@progress_message(__('generating indices'))
def gen_indices(self): (source)

Undocumented

def gen_pages_from_extensions(self): (source)

Undocumented

def get_asset_paths(self): (source)
overrides sphinx.builders.Builder.get_asset_paths

Return list of paths for assets (ex. templates, CSS, etc.).

Returns
list[str]Undocumented
def get_doc_context(self, docname, body, metatags): (source)
overridden in sphinx.builders.singlehtml.SingleFileHTMLBuilder

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.Builder.get_outdated_docs
overridden in sphinx.builders.singlehtml.SingleFileHTMLBuilder

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_outfilename(self, pagename): (source)
overridden in sphinx.builders.dirhtml.DirectoryHTMLBuilder

Undocumented

Parameters
pagename:strUndocumented
Returns
strUndocumented
def get_target_uri(self, docname, typ=None): (source)
overrides sphinx.builders.Builder.get_target_uri
overridden in sphinx.builders.dirhtml.DirectoryHTMLBuilder, sphinx.builders.singlehtml.SingleFileHTMLBuilder

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 get_theme_config(self): (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

Returns
tuple[str, dict]Undocumented
def handle_finish(self): (source)
overridden in sphinx.builders.epub3.Epub3Builder

Undocumented

def handle_page(self, pagename, addctx, templatename='page.html', outfilename=None, event_arg=None): (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

Parameters
pagename:strUndocumented
addctx:dictUndocumented
templatename:strUndocumented
outfilename:str|NoneUndocumented
event_arg:AnyUndocumented
def index_page(self, pagename, doctree, title): (source)

Undocumented

Parameters
pagename:strUndocumented
doctree:nodes.documentUndocumented
title:strUndocumented
def init(self): (source)
overrides sphinx.builders.Builder.init
overridden in sphinx.builders._epub_base.EpubBuilder

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

def init_css_files(self): (source)

Undocumented

def init_highlighter(self): (source)

Undocumented

def init_js_files(self): (source)

Undocumented

def init_templates(self): (source)

Undocumented

def load_indexer(self, docnames): (source)

Undocumented

Parameters
docnames:Iterable[str]Undocumented
def post_process_images(self, doctree): (source)
overrides sphinx.builders.Builder.post_process_images

Pick the best candidate for an image and link down-scaled images to their high res version.

Parameters
doctree:NodeUndocumented
def prepare_writing(self, docnames): (source)
overrides sphinx.builders.Builder.prepare_writing
overridden in sphinx.builders.epub3.Epub3Builder

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

Parameters
docnames:set[str]Undocumented
def render_partial(self, node): (source)

Utility: Render a lone doctree node.

Parameters
node:Node|NoneUndocumented
Returns
dict[str, str]Undocumented
def update_page_context(self, pagename, templatename, ctx, event_arg): (source)

Undocumented

Parameters
pagename:strUndocumented
templatename:strUndocumented
ctx:dictUndocumented
event_arg:AnyUndocumented
def write_buildinfo(self): (source)

Undocumented

def write_doc(self, docname, doctree): (source)
overrides sphinx.builders.Builder.write_doc
overridden in sphinx.builders._epub_base.EpubBuilder

Where you actually write something to the filesystem.

Parameters
docname:strUndocumented
doctree:nodes.documentUndocumented
def write_doc_serialized(self, docname, doctree): (source)
overrides sphinx.builders.Builder.write_doc_serialized

Handle parts of write_doc that must be called in the main process if parallel build is active.

Parameters
docname:strUndocumented
doctree:nodes.documentUndocumented
def write_domain_indices(self): (source)

Undocumented

def write_genindex(self): (source)

Undocumented

add_permalinks: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

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

Undocumented

allow_sharp_as_current_path: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

copysource: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder, sphinx.builders.singlehtml.SingleFileHTMLBuilder

Undocumented

download_support: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

embedded: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

epilog = (source)
overrides sphinx.builders.Builder.epilog
overridden in sphinx.builders.epub3.Epub3Builder, sphinx.builders.singlehtml.SingleFileHTMLBuilder

Undocumented

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

Undocumented

html_scaled_image_link: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

indexer_dumps_unicode: bool = (source)

Undocumented

name: str = (source)
overrides sphinx.builders.Builder.name
overridden in sphinx.builders.dirhtml.DirectoryHTMLBuilder, sphinx.builders.epub3.Epub3Builder, sphinx.builders.singlehtml.SingleFileHTMLBuilder

Undocumented

search: bool = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

searchindex_filename: str = (source)

Undocumented

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

Undocumented

supported_image_types: list[str] = (source)
overrides sphinx.builders.Builder.supported_image_types
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

supported_remote_images: bool = (source)
overrides sphinx.builders.Builder.supported_remote_images
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

build_info = (source)

Undocumented

css_files: list = (source)

Undocumented

current_docname = (source)

Undocumented

dark_highlighter = (source)

Undocumented

dlpath = (source)

Undocumented

docsettings: Any = (source)

Undocumented

docwriter = (source)

Undocumented

domain_indices: list = (source)

Undocumented

fignumbers = (source)

Undocumented

globalcontext = (source)

Undocumented

highlighter = (source)

Undocumented

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

Undocumented

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

Undocumented

indexer = (source)

Undocumented

last_updated = (source)

Undocumented

link_suffix = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

out_suffix = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

relations = (source)

Undocumented

script_files: list = (source)

Undocumented

secnumbers = (source)

Undocumented

theme = (source)

Undocumented

theme_options = (source)

Undocumented

use_index = (source)
overridden in sphinx.builders._epub_base.EpubBuilder

Undocumented

@property
default_translator_class: type[nodes.NodeVisitor] = (source)
overrides sphinx.builders.Builder.default_translator_class

Undocumented

@property
math_renderer_name: str = (source)

Undocumented

def _get_local_toctree(self, docname, collapse=True, **kwargs): (source)
overridden in sphinx.builders.singlehtml.SingleFileHTMLBuilder

Undocumented

Parameters
docname:strUndocumented
collapse:boolUndocumented
**kwargs:AnyUndocumented
Returns
strUndocumented
def _get_style_filenames(self): (source)

Undocumented

Returns
Iterator[str]Undocumented
def _get_translations_js(self): (source)

Undocumented

Returns
strUndocumented
_css_files = (source)

Undocumented

_publisher = (source)

Undocumented

_script_files = (source)

Undocumented