def prepare_page_attributes(self, page):
"""
Banana banana
"""
page.output_attrs['html']['scripts'] = OrderedSet()
page.output_attrs['html']['stylesheets'] = OrderedSet()
page.output_attrs['html']['extra_html'] = []
page.output_attrs['html']['extra_footer_html'] = []
if HtmlFormatter.add_anchors:
page.output_attrs['html']['scripts'].add(
os.path.join(HERE, 'html_assets', 'css.escape.js'))
Formatter.prepare_page_attributes(self, page)
def prepare_page_attributes(self, page):
"""
Banana banana
"""
page.output_attrs['html']['scripts'] = OrderedSet()
page.output_attrs['html']['stylesheets'] = OrderedSet()
page.output_attrs['html']['extra_html'] = []
page.output_attrs['html']['extra_footer_html'] = []
if HtmlFormatter.add_anchors:
page.output_attrs['html']['scripts'].add(
os.path.join(HERE, 'html_assets', 'css.escape.js'))
Formatter.prepare_page_attributes(self, page)
def write_page(self, page, output):
root = etree.HTML(unicode(page.detailed_description))
id_nodes = {n.attrib['id']: "".join([x for x in n.itertext()])
for n in root.xpath('.//*[@id]')}
section_numbers = self.__init_section_numbers(root)
targets = root.xpath(
'.//*[self::h1 or self::h2 or self::h3 or '
'self::h4 or self::h5 or self::img]')
for target in targets:
section_number = self.__update_section_number(
target, section_numbers)
if 'id' in target.attrib:
continue
if target.tag == 'img':
text = target.attrib.get('alt')
else:
text = "".join([x for x in target.itertext()])
if not text:
continue
id_ = id_from_text(text)
ref_id = id_
index = 1
while id_ in id_nodes:
id_ = '%s%s' % (ref_id, index)
index += 1
if section_number:
target.text = '%s %s' % (section_number, target.text or '')
target.attrib['id'] = id_
id_nodes[id_] = text
empty_links = root.xpath('.//a[not(text()) and not(*)]')
for link in empty_links:
href = link.attrib.get('href')
if href and href.startswith('#'):
title = id_nodes.get(href.strip('#'))
if title:
link.text = title
else:
warn('bad-local-link',
"Empty anchor link to %s in %s points nowhere" %
(href, page.source_file))
link.text = "FIXME broken link to %s" % href
page.detailed_description = lxml.html.tostring(
root, doctype="<!DOCTYPE html>", encoding='unicode',
include_meta_content_type=True)
return Formatter.write_page(self, page, output)
def write_page(self, page, output):
root = etree.HTML(unicode(page.detailed_description))
id_nodes = {n.attrib['id']: "".join([x for x in n.itertext()])
for n in root.xpath('.//*[@id]')}
section_numbers = self.__init_section_numbers(root)
targets = root.xpath(
'.//*[self::h1 or self::h2 or self::h3 or '
'self::h4 or self::h5 or self::img]')
for target in targets:
section_number = self.__update_section_number(
target, section_numbers)
if 'id' in target.attrib:
continue
if target.tag == 'img':
text = target.attrib.get('alt')
else:
text = "".join([x for x in target.itertext()])
if not text:
continue
id_ = id_from_text(text)
ref_id = id_
index = 1
while id_ in id_nodes:
id_ = '%s%s' % (ref_id, index)
index += 1
if section_number:
target.text = '%s %s' % (section_number, target.text or '')
target.attrib['id'] = id_
id_nodes[id_] = text
empty_links = root.xpath('.//a[not(text()) and not(*)]')
for link in empty_links:
href = link.attrib.get('href')
if href and href.startswith('#'):
title = id_nodes.get(href.strip('#'))
if title:
link.text = title
else:
warn('bad-local-link',
"Empty anchor link to %s in %s points nowhere" %
(href, page.source_file))
link.text = "FIXME broken link to %s" % href
page.detailed_description = lxml.html.tostring(
root, doctype="<!DOCTYPE html>", encoding='unicode',
include_meta_content_type=True)
return Formatter.write_page(self, page, output)
def __init__(self, searchpath):
Formatter.__init__(self)
self._symbol_formatters = {
FunctionSymbol: self._format_function,
FunctionMacroSymbol: self._format_function_macro,
CallbackSymbol: self._format_callback,
ConstantSymbol: self._format_constant,
ExportedVariableSymbol: self._format_constant,
AliasSymbol: self._format_alias,
StructSymbol: self._format_struct,
EnumSymbol: self._format_enum,
ParameterSymbol: self._format_parameter_symbol,
ReturnItemSymbol: self._format_return_item_symbol,
FieldSymbol: self._format_field_symbol,
SignalSymbol: self._format_signal_symbol,
VFunctionSymbol: self._format_vfunction_symbol,
PropertySymbol: self._format_property_symbol,
ClassSymbol: self._format_class_symbol,
InterfaceSymbol: self._format_interface_symbol,
}
self._ordering = [InterfaceSymbol, ClassSymbol, FunctionSymbol,
FunctionMacroSymbol, SignalSymbol,
PropertySymbol, StructSymbol,
VFunctionSymbol, EnumSymbol, ConstantSymbol,
ExportedVariableSymbol, AliasSymbol, CallbackSymbol]
if HtmlFormatter.theme_path:
theme_templates_path = os.path.join(
HtmlFormatter.theme_path, 'templates')
if os.path.exists(theme_templates_path):
searchpath.insert(0, theme_templates_path)
searchpath.append(os.path.join(HERE, "html_templates"))
self.engine = Engine(
loader=FileLoader(searchpath, encoding='UTF-8'),
extensions=[CoreExtension(), CodeExtension()]
)
self.all_scripts = set()
self.all_stylesheets = set()
self._docstring_formatter = GtkDocStringFormatter()
def __init__(self, searchpath):
Formatter.__init__(self)
self._symbol_formatters = {
FunctionSymbol: self._format_function,
FunctionMacroSymbol: self._format_function_macro,
CallbackSymbol: self._format_callback,
ConstantSymbol: self._format_constant,
ExportedVariableSymbol: self._format_constant,
AliasSymbol: self._format_alias,
StructSymbol: self._format_struct,
EnumSymbol: self._format_enum,
ParameterSymbol: self._format_parameter_symbol,
ReturnItemSymbol: self._format_return_item_symbol,
FieldSymbol: self._format_field_symbol,
SignalSymbol: self._format_signal_symbol,
VFunctionSymbol: self._format_vfunction_symbol,
PropertySymbol: self._format_property_symbol,
ClassSymbol: self._format_class_symbol,
InterfaceSymbol: self._format_interface_symbol,
}
self._ordering = [InterfaceSymbol, ClassSymbol, FunctionSymbol,
FunctionMacroSymbol, SignalSymbol,
PropertySymbol, StructSymbol,
VFunctionSymbol, EnumSymbol, ConstantSymbol,
ExportedVariableSymbol, AliasSymbol, CallbackSymbol]
if HtmlFormatter.theme_path:
self.__load_theme_templates(searchpath,
HtmlFormatter.theme_path)
if HtmlFormatter.extra_theme_path:
self.__load_theme_templates(searchpath,
HtmlFormatter.extra_theme_path)
searchpath.append(os.path.join(HERE, "html_templates"))
self.engine = Engine(
loader=FileLoader(searchpath, encoding='UTF-8'),
extensions=[CoreExtension(), CodeExtension()]
)
self.all_scripts = set()
self.all_stylesheets = set()
self._docstring_formatter = GtkDocStringFormatter()
def write_page(self, page, build_root, output):
root = etree.HTML(unicode(page.detailed_description))
id_nodes = {n.attrib['id']: "".join([x for x in n.itertext()])
for n in root.xpath('.//*[@id]')}
section_numbers = self.__init_section_numbers(root)
targets = root.xpath(
'.//*[self::h1 or self::h2 or self::h3 or '
'self::h4 or self::h5 or self::img]')
for target in targets:
section_number = self.__update_section_number(
target, section_numbers)
if 'id' in target.attrib:
continue
if target.tag == 'img':
text = target.attrib.get('alt')
else:
text = "".join([x for x in target.itertext()])
if not text:
continue
id_ = id_from_text(text)
ref_id = id_
index = 1
while id_ in id_nodes:
id_ = '%s%s' % (ref_id, index)
index += 1
if section_number:
target.text = '%s %s' % (section_number, target.text or '')
target.attrib['id'] = id_
id_nodes[id_] = text
empty_links = root.xpath('.//a[not(text()) and not(*)]')
for link in empty_links:
href = link.attrib.get('href')
if href and href.startswith('#'):
title = id_nodes.get(href.strip('#'))
if title:
link.text = title
else:
warn('bad-local-link',
"Empty anchor link to %s in %s points nowhere" %
(href, page.source_file))
link.text = "FIXME broken link to %s" % href
page.detailed_description = lxml.html.tostring(
root, doctype="<!DOCTYPE html>", encoding='unicode',
include_meta_content_type=True)
full_path = Formatter.write_page(self, page, build_root, output)
images = root.xpath('.//img')
# All required assets should now be in place
for img in images:
src = img.attrib.get('src')
if not src:
warn('no-image-src',
'Empty image source in %s' % page.source_file)
continue
comps = urlparse.urlparse(src)
if comps.scheme:
continue
path = os.path.abspath(os.path.join(
os.path.dirname(full_path), src))
if not os.path.exists(path):
warn('bad-image-src',
('In %s, a local image refers to an unknown source (%s). '
'It should be available in the build folder, at %s') %
(page.source_file, src, path))
continue
return full_path