swh:1:snp:cbce47b405be61c06306104d606512f3dfad8dcb
Tip revision: a134c04d8fb59769678456fb41d02fd169be7b06 authored by James Seager on 22 November 2022, 15:00:39 UTC
Add IDs to level 4 headings
Add IDs to level 4 headings
Tip revision: a134c04
compile_docs.py
import functools
import glob
from inspect import cleandoc
import os
import re
import lxml.html, lxml.etree
import markdown
from PIL import Image
def newer_than(path1, path2):
return os.stat(path1).st_mtime > os.stat(path2).st_mtime
def get_filename(path, ext=True):
basename = os.path.basename(path)
return basename if ext else os.path.splitext(basename)[0]
def make_image(src, dst):
with Image.open(src, formats=['PNG']) as img:
img.convert(mode='RGB') \
.quantize(colors=32, dither='NONE') \
.save(dst, 'PNG')
def generate_heading_ids(html):
heading_tags = {'h1', 'h2', 'h3', 'h4'}
fragments = lxml.html.fragments_fromstring(html)
for element in fragments:
if element.tag in heading_tags:
text = ''.join(element.itertext())
id_text = re.sub(r'\W', '_', text.lower())
element.set('id', id_text)
return ''.join(
lxml.etree.tostring(element, encoding=str, method='html')
for element in fragments
)
def link_html_images(html):
image_link_elem = (
'<a href="<% $c->uri_for($image_path . \'/{image}\') %>"/>'
'<img class="screenshot"'
' src="<% $c->uri_for($image_path . \'/{image}\') %>"'
' alt=""/>'
'</a>'
)
image_template = cleandoc("""
<div class="row-fluid">
<div class="span6">
{image_link}
</div>
</div>
""".format(image_link=image_link_elem))
image_re = re.compile(
r'<p><img alt="" src="images/(?P<image>\w+\.png)" title=""\s*/?></p>'
)
out_lines = []
for line in html.split('\n'):
match = image_re.match(line)
if match:
image_name = match.group('image')
out_lines.append(image_template.format(image=image_name))
else:
out_lines.append(line)
return '\n'.join(out_lines)
def add_catalyst_markup(html):
template = cleandoc("""
<!-- PAGE_TITLE: @@name@@ Documentation -->
<!-- FLAGS: use_bootstrap -->
{body}
<%init>
my $config = $c->config();
my $base_docs_path = $config->{{base_docs_path}};
my $image_path = '/static/images/' . $base_docs_path;
</%init>
""")
return template.format(body=html)
def add_table_classes(html):
table_re = re.compile(r'<table>')
repl = '<table class="table table-striped table-bordered table-condensed">'
return table_re.sub(repl, html)
def make_mhtml_from_md(in_dir, out_dir):
markdown_paths = glob.glob(os.path.join(in_dir, '*.md'))
for markdown_path in markdown_paths:
with open(markdown_path, encoding='utf8') as markdown_file:
markdown_doc = markdown_file.read()
pipeline = (
lambda md: markdown.markdown(md, extensions=['tables']),
generate_heading_ids,
link_html_images,
add_table_classes,
add_catalyst_markup
)
mhtml_doc = functools.reduce(
lambda x, f: f(x),
pipeline,
markdown_doc
)
markdown_filename = get_filename(markdown_path, ext=False)
mhtml_filename = markdown_filename + '.mhtml'
out_path = os.path.join(out_dir, mhtml_filename)
write_args = {
'mode': 'w+',
'encoding': 'utf8',
'newline': '\n'
}
with open(out_path, **write_args) as mhtml_file:
mhtml_file.write(mhtml_doc + '\n')
def make_images(in_dir, out_dir):
image_files = glob.glob(os.path.join(in_dir, '*.png'))
for image_path in image_files:
src = image_path
image_filename = get_filename(image_path)
dst = os.path.join(out_dir, image_filename)
if not os.path.exists(dst) or not newer_than(src, dst):
make_image(src, dst)
def main():
file_dir = os.path.abspath(os.path.dirname(__file__))
docs_input_dir = os.path.join(file_dir, 'docs')
output_dir = os.path.join(file_dir, 'build')
if not os.path.exists(output_dir):
os.mkdir(output_dir)
image_input_dir = os.path.join(docs_input_dir, 'images')
image_output_dir = os.path.join(output_dir, 'images')
if not os.path.exists(image_output_dir):
os.mkdir(image_output_dir)
make_mhtml_from_md(docs_input_dir, output_dir)
make_images(image_input_dir, image_output_dir)
if __name__ == '__main__':
main()