sphinx.builders.epub3.Epub3Builder

class documentation

class Epub3Builder(_epub_base.EpubBuilder): (source)

View In Hierarchy

Builder that outputs epub3 files. It creates the metainfo files content.opf, nav.xhtml, toc.ncx, mimetype, and META-INF/container.xml. Afterwards, all necessary files are zipped to an epub file.

Method build_navigation_doc Write the metainfo file nav.xhtml.
Method build_navlist Create the toc navigation structure.
Method content_metadata Create a dictionary with all metadata for the content.opf file properly escaped.
Method handle_finish Create the metainfo files and finally the epub.
Method navigation_doc_metadata Create a dictionary with all metadata for the nav.xhtml file properly escaped.
Method prepare_writing A place where you can add logic before :meth:`write_doc` is run
Class Variable epilog Undocumented
Class Variable name Undocumented
Class Variable supported_remote_images Undocumented
Class Variable template_dir Undocumented
Class Variable use_meta_charset Undocumented

Inherited from EpubBuilder:

Method add_visible_links Add visible link targets for external links
Method build_container Write the metainfo file META-INF/container.xml.
Method build_content Write the metainfo file content.opf It contains bibliographic data, a file list and the spine (the reading order).
Method build_epub Write the epub file.
Method build_mimetype Write the metainfo file mimetype.
Method build_navpoints Create the toc navigation structure.
Method build_toc Write the metainfo file toc.ncx.
Method check_refnodes Undocumented
Method copy_download_files Undocumented
Method copy_image_files Copy image files to destination directory. This overwritten method can use Pillow to convert image files.
Method copy_image_files_pil Copy images using Pillow, the Python Imaging Library. The method tries to read and write the files with Pillow, converting the format and resizing the image if necessary/possible.
Method create_build_info Undocumented
Method fix_fragment Return a href/id attribute with colons replaced by hyphens.
Method fix_genindex Fix href attributes for genindex pages.
Method fix_ids Replace colons with hyphens in href and id attributes.
Method get_refnodes Collect section titles, their depth in the toc and the refuri.
Method get_theme_config Undocumented
Method get_toc Get the total table of contents, containing the root_doc and pre and post files not managed by sphinx.
Method handle_page Create a rendered page.
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method is_vector_graphics Does the filename extension indicate a vector graphic format?
Method make_id Return a unique id for name.
Method new_navpoint Create a new entry in the toc from the node at given level.
Method toc_add_files Add the root_doc, pre and post files to a list of refnodes.
Method toc_metadata Create a dictionary with all metadata for the toc.ncx file properly escaped.
Method write_doc Write one document file.
Class Variable add_permalinks Undocumented
Class Variable allow_sharp_as_current_path Undocumented
Class Variable copysource Undocumented
Class Variable doctype Undocumented
Class Variable download_support Undocumented
Class Variable embedded Undocumented
Class Variable html_scaled_image_link Undocumented
Class Variable search Undocumented
Class Variable supported_image_types Undocumented
Instance Variable files Undocumented
Instance Variable id_cache Undocumented
Instance Variable ignored_files Undocumented
Instance Variable link_suffix Undocumented
Instance Variable out_suffix Undocumented
Instance Variable playorder Undocumented
Instance Variable refnodes Undocumented
Instance Variable tocid Undocumented
Instance Variable use_index Undocumented

Inherited from StandaloneHTMLBuilder (via EpubBuilder):

Method __init__ Undocumented
Method add_css_file Undocumented
Method add_js_file Undocumented
Method add_sidebars Undocumented
Method cleanup Cleanup any resources.
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_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_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 index_page Undocumented
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 render_partial Utility: Render a lone doctree node.
Method update_page_context Undocumented
Method write_buildinfo 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_domain_indices Undocumented
Method write_genindex Undocumented
Class Variable allow_parallel Undocumented
Class Variable format Undocumented
Class Variable indexer_dumps_unicode Undocumented
Class Variable searchindex_filename Undocumented
Class Variable supported_data_uri_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 relations Undocumented
Instance Variable script_files Undocumented
Instance Variable secnumbers Undocumented
Instance Variable theme Undocumented
Instance Variable theme_options 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 (via EpubBuilder, 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_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 build_navigation_doc(self): (source)

Write the metainfo file nav.xhtml.

def build_navlist(self, navnodes): (source)

Create the toc navigation structure. This method is almost same as build_navpoints method in epub.py. This is because the logical navigation structure of epub3 is not different from one of epub2. The difference from build_navpoints method is templates which are used when generating navigation documents.

Parameters
navnodes:list[dict[str, Any]]Undocumented
Returns
list[NavPoint]Undocumented
def content_metadata(self): (source)
overrides sphinx.builders._epub_base.EpubBuilder.content_metadata

Create a dictionary with all metadata for the content.opf file properly escaped.

Returns
dict[str, Any]Undocumented
def handle_finish(self): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.handle_finish

Create the metainfo files and finally the epub.

def navigation_doc_metadata(self, navlist): (source)

Create a dictionary with all metadata for the nav.xhtml file properly escaped.

Parameters
navlist:list[NavPoint]Undocumented
Returns
dict[str, Any]Undocumented
def prepare_writing(self, docnames): (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.prepare_writing

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

Parameters
docnames:set[str]Undocumented
epilog = (source)
overrides sphinx.builders.html.StandaloneHTMLBuilder.epilog

Undocumented

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

Undocumented

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

Undocumented

template_dir = (source)
overrides sphinx.builders._epub_base.EpubBuilder.template_dir

Undocumented

use_meta_charset: bool = (source)

Undocumented