Lines Matching +full:os +full:- +full:initiated
1 # -*- coding: utf-8; mode: python -*-
14 handling from the author's POV. Directives like ``kernel-figure`` implement
15 methods *to* always get the best output-format even if some tools are not
19 * ``.. kernel-image``: for image handling / a ``.. image::`` replacement
21 * ``.. kernel-figure``: for figure handling / a ``.. figure::`` replacement
23 * ``.. kernel-render``: for render markup / a concept to embed *render*
26 - ``DOT``: render embedded Graphviz's **DOC**
27 - ``SVG``: render embedded Scalable Vector Graphics (**SVG**)
28 - ... *developable*
33 available, the DOT language is inserted as literal-block.
34 For conversion to PDF, ``rsvg-convert(1)`` of librsvg
39 - ``convert(1)``: ImageMagick (https://www.imagemagick.org)
40 - ``inkscape(1)``: Inkscape (https://inkscape.org/)
46 * generate SVG (html-builder) and PDF (latex-builder) from DOT files.
47 DOT: see https://www.graphviz.org/content/dot-language
51 import os
52 from os import path
75 # -------------
83 envpath = os.environ.get('PATH', None) or os.defpath
84 for folder in envpath.split(os.pathsep):
85 fname = folder + os.sep + cmd
91 os.makedirs(folder, mode)
106 and os.stat(path1).st_ctime > os.stat(path2).st_ctime)
112 # -------------------------------------------
116 # dot(1) -Tpdf should be used
122 # librsvg's rsvg-convert(1) support
133 app.connect('builder-inited', setupTools)
136 app.add_directive("kernel-image", KernelImage)
145 app.add_directive("kernel-figure", KernelFigure)
154 app.add_directive('kernel-render', KernelRender)
162 app.connect('doctree-read', add_kernel_figure_to_std_domain)
175 This function is called once, when the builder is initiated.
183 rsvg_convert_cmd = which('rsvg-convert')
190 dot_Thelp_list = subprocess.check_output([dot_cmd, '-Thelp'],
203 inkscape_ver = subprocess.check_output([inkscape_cmd, '--version'],
222 kernellog.verbose(app, "use rsvg-convert(1) from: " + rsvg_convert_cmd)
223 kernellog.verbose(app, "use 'dot -Tsvg' and rsvg-convert(1) for DOT -> PDF conversion")
227 "rsvg-convert(1) not found.\n"
228 " SVG rendering of convert(1) is done by ImageMagick-native renderer.")
230 kernellog.verbose(app, "use 'dot -Tpdf' for DOT -> PDF conversion")
232 kernellog.verbose(app, "use 'dot -Tsvg' and convert(1) for DOT -> PDF conversion")
236 # --------------------------
264 # in kernel builds, use 'make SPHINXOPTS=-v' to see verbose messages
348 option ``-Txxx``). Normally you will use one of the following extensions:
350 - ``.ps`` for PostScript,
351 - ``.svg`` or ``svgz`` for Structured Vector Graphics,
352 - ``.fig`` for XFIG graphics and
353 - ``.png`` or ``gif`` for common bitmap graphics.
357 cmd = [dot_cmd, '-T%s' % out_format, dot_fname]
384 cmd = [inkscape_cmd, '-o', pdf_fname, svg_fname]
386 cmd = [inkscape_cmd, '-z', '--export-pdf=%s' % pdf_fname, svg_fname]
400 % (cmd_name, str(warning_msg, 'utf-8')))
403 % (cmd_name, str(warning_msg, 'utf-8')))
408 """Convert SVG to PDF with ``rsvg-convert(1)`` command.
414 SVG -> PDF conversion is done by ``rsvg-convert(1)``.
416 If ``rsvg-convert(1)`` is unavailable, fall back to ``svg2pdf()``.
423 cmd = [rsvg_convert_cmd, '--format=pdf', '-o', pdf_fname, svg_fname]
434 # ---------------------
439 Handles the ``image`` child-node with the ``convert_image(...)``.
445 """Node for ``kernel-image`` directive."""
458 if uri.endswith('.*') or uri.find('://') != -1:
471 # ---------------------
476 Handles the ``image`` child-node with the ``convert_image(...)``.
482 """Node for ``kernel-figure`` directive."""
494 if uri.endswith('.*') or uri.find('://') != -1:
509 # ---------------------
517 image child-node with the ``convert_image(...)``.
522 kernellog.verbose(app, 'visit kernel-render node lang: "%s"' % (srclang))
526 kernellog.warn(app, 'kernel-render: "%s" unknown / include raw.' % (srclang))
536 hashobj = code.encode('utf-8') # str(node.attributes)
537 fname = path.join('%s-%s' % (srclang, sha1(hashobj).hexdigest()))
557 """Node for ``kernel-render`` directive."""
627 """Add kernel-figure anchors to 'std' domain.
630 the caption (label) of ``kernel-figure`` directive (it only knows about
632 this will result in a 'undefined label' for kernel-figures.
634 This handle adds labels of kernel-figure to the 'std' domain labels.