sphinx.builders.epub3

module documentation
(source)

Build epub3 files. Originally derived from epub.py.

Class Epub3Builder Builder that outputs epub3 files.
Class NavPoint 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
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
Constant _XML_NAME_PATTERN Undocumented
Variable _xml_name_char Undocumented
Variable _xml_name_start_char Undocumented
def convert_epub_css_files(app, config): (source)

This converts string styled epub_css_files to tuple styled one.

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def setup(app): (source)

Undocumented

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

Undocumented

Parameters
app:SphinxUndocumented
DOCTYPE: str = (source)

Undocumented

Value
'<!DOCTYPE html>'
HTML_TAG: str = (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

_XML_NAME_PATTERN = (source)

Undocumented

Value
re.compile(f"""({_xml_name_start_char})({_xml_name_char})*""")
_xml_name_char = (source)

Undocumented

_xml_name_start_char: str = (source)

Undocumented