4.6.2.13. sphinx.builders.html.SingleFileHTMLBuilder¶
-
class
sphinx.builders.html.SingleFileHTMLBuilder(app)[source]¶ A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.
4.6.2.13.1. Methods¶
__init__(app) |
|
add_sidebars(pagename, ctx) |
|
assemble_doctree() |
|
assemble_toc_secnumbers() |
|
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() |
|
compile_all_catalogs() |
|
compile_catalogs(catalogs, message) |
|
compile_specific_catalogs(specified_files) |
|
compile_update_catalogs() |
|
copy_download_files() |
|
copy_extra_files() |
|
copy_image_files() |
|
copy_static_files() |
|
create_template_bridge() |
Return the template bridge configured. |
dump_inventory() |
|
dump_search_index() |
|
finish() |
|
fix_refuris(tree) |
|
gen_additional_pages() |
|
gen_indices() |
|
get_builder_config(option, default) |
Return a builder specific option. |
get_doc_context(docname, body, metatags) |
|
get_outdated_docs() |
|
get_outfilename(pagename) |
|
get_relative_uri(from_, to[, typ]) |
|
get_target_uri(docname[, typ]) |
|
get_theme_config() |
|
handle_finish() |
|
handle_page(pagename, addctx[, ...]) |
|
index_page(pagename, doctree, title) |
|
init() |
|
init_highlighter() |
|
init_templates() |
|
init_translator_class() |
|
load_indexer(docnames) |
|
post_process_images(doctree) |
Pick the best candidate for an image and link down-scaled images to their high res version. |
prepare_writing(docnames) |
|
render_partial(node) |
Utility: Render a lone doctree node. |
write(*ignored) |
|
write_buildinfo() |
|
write_doc(docname, doctree) |
|
write_doc_serialized(docname, doctree) |
|
write_domain_indices() |
|
write_genindex() |