sphinx.builders.epub3

module documentation

Build epub3 files. Originally derived from epub.py.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Class ​Epub3​Builder Builder that outputs epub3 files.
Constant DOCTYPE Undocumented
Constant HTML​_TAG Undocumented
Constant IBOOK​_SCROLL​_AXIS Undocumented
Constant PAGE​_PROGRESSION​_DIRECTIONS Undocumented
Constant THEME​_WRITING​_MODES Undocumented
Variable logger Undocumented
Class ​Nav​Point Undocumented
Function convert​_epub​_css​_files This converts string styled epub_css_files to tuple styled one.
Function setup Undocumented
Function validate​_config​_values Undocumented
DOCTYPE: str =

Undocumented

Value
'<!DOCTYPE html>'
HTML_TAG: str =

Undocumented

Value
'<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007↵
/ops">'
IBOOK_SCROLL_AXIS: dict[str, str] =

Undocumented

Value
{'horizontal': 'vertical', 'vertical': 'horizontal'}
PAGE_PROGRESSION_DIRECTIONS: dict[str, str] =

Undocumented

Value
{'horizontal': 'ltr', 'vertical': 'rtl'}
THEME_WRITING_MODES: dict[str, str] =

Undocumented

Value
{'vertical': 'vertical-rl', 'horizontal': 'horizontal-tb'}
logger =

Undocumented

def convert_epub_css_files(app, config):
This converts string styled epub_css_files to tuple styled one.
Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented
def validate_config_values(app):

Undocumented

Parameters
app:SphinxUndocumented