././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1575997324.8968413 sphinxcontrib-nwdiag-2.0.0/0000755000076600000240000000000000000000000016454 5ustar00tkomiyastaff00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823145.0 sphinxcontrib-nwdiag-2.0.0/AUTHORS0000644000076600000240000000004500000000000017523 0ustar00tkomiyastaff00000000000000Takeshi KOMIYA ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823145.0 sphinxcontrib-nwdiag-2.0.0/LICENSE0000644000076600000240000000261200000000000017462 0ustar00tkomiyastaff00000000000000If not otherwise noted, the extensions in this package are licensed under the following license. Copyright (c) 2009 by the contributors (see AUTHORS file). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823145.0 sphinxcontrib-nwdiag-2.0.0/MANIFEST.in0000644000076600000240000000010500000000000020206 0ustar00tkomiyastaff00000000000000include AUTHORS include LICENSE include README.rst include CHANGES.* ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1575997324.897141 sphinxcontrib-nwdiag-2.0.0/PKG-INFO0000644000076600000240000000501600000000000017553 0ustar00tkomiyastaff00000000000000Metadata-Version: 1.1 Name: sphinxcontrib-nwdiag Version: 2.0.0 Summary: Sphinx "nwdiag" extension Home-page: http://github.com/blockdiag/sphinxcontrib-nwdiag Author: Takeshi KOMIYA Author-email: i.tkomiya@gmail.com License: BSD Description: ==================== sphinxcontrib-nwdiag ==================== .. image:: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag.svg?branch=master :target: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag .. image:: https://coveralls.io/repos/blockdiag/sphinxcontrib-nwdiag/badge.png?branch=master :target: https://coveralls.io/r/blockdiag/sphinxcontrib-nwdiag?branch=master .. image:: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag/badges/gpa.svg :target: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag A sphinx extension for embedding network related diagrams using nwdiag_. For now, nwdiag supports these diagrams: - logical network diagram - rack structure diagram - packet structure diagram This extension enables you to insert network related diagrams into your document. Following code is an example:: .. nwdiag:: nwdiag { network { web01; web02; } network { web01; web02; db01; } } .. _nwdiag: http://bitbucket.org/blockdiag/nwdiag/ For more details, see `online documentation`_ at http://blockdiag.com/. .. _online documentation: http://blockdiag.com/en/nwdiag/sphinxcontrib.html Platform: any Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Environment :: Web Environment Classifier: Framework :: Sphinx :: Extension Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Topic :: Documentation Classifier: Topic :: Documentation :: Sphinx Classifier: Topic :: Utilities ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823145.0 sphinxcontrib-nwdiag-2.0.0/README.rst0000644000076600000240000000227200000000000020146 0ustar00tkomiyastaff00000000000000==================== sphinxcontrib-nwdiag ==================== .. image:: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag.svg?branch=master :target: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag .. image:: https://coveralls.io/repos/blockdiag/sphinxcontrib-nwdiag/badge.png?branch=master :target: https://coveralls.io/r/blockdiag/sphinxcontrib-nwdiag?branch=master .. image:: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag/badges/gpa.svg :target: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag A sphinx extension for embedding network related diagrams using nwdiag_. For now, nwdiag supports these diagrams: - logical network diagram - rack structure diagram - packet structure diagram This extension enables you to insert network related diagrams into your document. Following code is an example:: .. nwdiag:: nwdiag { network { web01; web02; } network { web01; web02; db01; } } .. _nwdiag: http://bitbucket.org/blockdiag/nwdiag/ For more details, see `online documentation`_ at http://blockdiag.com/. .. _online documentation: http://blockdiag.com/en/nwdiag/sphinxcontrib.html ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1575997324.8979368 sphinxcontrib-nwdiag-2.0.0/setup.cfg0000644000076600000240000000044300000000000020276 0ustar00tkomiyastaff00000000000000[egg_info] tag_build = tag_date = 0 [build] build-base = _build [sdist] formats = gztar [wheel] universal = 1 [aliases] release = check -r -s register sdist bdist_wheel upload [check] strict = 1 restructuredtext = 1 [flake8] max-line-length = 120 ignore = W504 exclude = tests/docs/ ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997287.0 sphinxcontrib-nwdiag-2.0.0/setup.py0000644000076600000240000000262500000000000020173 0ustar00tkomiyastaff00000000000000# -*- coding: utf-8 -*- from setuptools import setup, find_packages requires = ['blockdiag>=1.5.0', 'nwdiag>=1.0.3', 'Sphinx>=2.0'] setup( name='sphinxcontrib-nwdiag', version='2.0.0', url='http://github.com/blockdiag/sphinxcontrib-nwdiag', license='BSD', author='Takeshi KOMIYA', author_email='i.tkomiya@gmail.com', description='Sphinx "nwdiag" extension', long_description=open('README.rst').read(), zip_safe=False, classifiers=[ 'Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Environment :: Web Environment', 'Framework :: Sphinx :: Extension', 'Intended Audience :: Developers', 'License :: OSI Approved :: BSD License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3 :: Only', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Topic :: Documentation', 'Topic :: Documentation :: Sphinx', 'Topic :: Utilities', ], platforms='any', packages=find_packages(exclude=['tests', 'tests.*']), include_package_data=True, install_requires=requires, namespace_packages=['sphinxcontrib'], ) ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1575997324.894182 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib/0000755000076600000240000000000000000000000021346 5ustar00tkomiyastaff00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823145.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib/__init__.py0000644000076600000240000000055500000000000023464 0ustar00tkomiyastaff00000000000000# -*- coding: utf-8 -*- """ sphinxcontrib ~~~~~~~~~~~~~ This package is a namespace package that contains all extensions distributed in the ``sphinx-contrib`` distribution. :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ __import__('pkg_resources').declare_namespace(__name__) ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997263.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib/nwdiag.py0000644000076600000240000002602200000000000023173 0ustar00tkomiyastaff00000000000000# -*- coding: utf-8 -*- """ nwdiag.sphinx_ext ~~~~~~~~~~~~~~~~~~~~ Allow nwdiag-formatted diagrams to be included in Sphinx-generated documents inline. :copyright: Copyright 2010 by Takeshi Komiya. :license: BSDL. """ from __future__ import absolute_import import os import re import posixpath import traceback import pkg_resources from collections import namedtuple from docutils import nodes from sphinx import addnodes from sphinx.util import logging from sphinx.util.osutil import ensuredir import nwdiag.utils.rst.nodes import nwdiag.utils.rst.directives from blockdiag.utils.bootstrap import detectfont, Application from blockdiag.utils.fontmap import FontMap from blockdiag.utils.rst.directives import with_blockdiag # fontconfig; it will be initialized on `builder-inited` event. fontmap = None logger = logging.getLogger(__name__) class nwdiag_node(nwdiag.utils.rst.nodes.nwdiag): def to_drawer(self, image_format, builder, **kwargs): if 'filename' in kwargs: filename = kwargs.pop('filename') else: filename = self.get_abspath(image_format, builder) antialias = builder.config.nwdiag_antialias transparency = builder.config.nwdiag_transparency image = super(nwdiag_node, self).to_drawer(image_format, filename, fontmap, antialias=antialias, transparency=transparency, **kwargs) for node in image.diagram.traverse_nodes(): node.href = resolve_reference(builder, node.href) return image def get_relpath(self, image_format, builder): options = dict(antialias=builder.config.nwdiag_antialias, fontpath=builder.config.nwdiag_fontpath, fontmap=builder.config.nwdiag_fontmap, format=image_format, transparency=builder.config.nwdiag_transparency) if hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) or HTML writer outputdir = builder.imgpath else: outputdir = '' return posixpath.join(outputdir, self.get_path(**options)) def get_abspath(self, image_format, builder): options = dict(antialias=builder.config.nwdiag_antialias, fontpath=builder.config.nwdiag_fontpath, fontmap=builder.config.nwdiag_fontmap, format=image_format, transparency=builder.config.nwdiag_transparency) if hasattr(builder, 'imagedir'): # Sphinx (>= 1.3.x) outputdir = os.path.join(builder.outdir, builder.imagedir) elif hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) and HTML writer outputdir = os.path.join(builder.outdir, '_images') else: outputdir = builder.outdir path = os.path.join(outputdir, self.get_path(**options)) ensuredir(os.path.dirname(path)) return path class Nwdiag(nwdiag.utils.rst.directives.NwdiagDirective): node_class = nwdiag_node def node2image(self, node, diagram): return node def resolve_reference(builder, href): if href is None: return None pattern = re.compile("^:ref:`(.+?)`", re.UNICODE) matched = pattern.search(href) if matched is None: return href elif not hasattr(builder, 'current_docname'): # ex. latex builder return matched.group(1) else: refid = matched.group(1) domain = builder.env.domains['std'] node = addnodes.pending_xref(refexplicit=False) xref = domain.resolve_xref(builder.env, builder.current_docname, builder, 'ref', refid, node, node) if xref: if 'refid' in xref: return "#" + xref['refid'] else: return xref['refuri'] else: logger.warning('undefined label: %s', refid) return None def html_render_svg(self, node): image = node.to_drawer('SVG', self.builder, filename=None, nodoctype=True) image.draw() if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
\n') # reftarget for node_id in node['ids']: self.body.append('' % node_id) # resize image size = image.pagesize().resize(**node['options']) self.body.append(image.save(size)) self.context.append('') def html_render_clickablemap(self, image, width_ratio, height_ratio): href_nodes = [node for node in image.nodes if node.href] if not href_nodes: return self.body.append('' % id(image)) for node in href_nodes: x1, y1, x2, y2 = image.metrics.cell(node) x1 *= width_ratio x2 *= width_ratio y1 *= height_ratio y2 *= height_ratio areatag = '' % (x1, y1, x2, y2, node.href) self.body.append(areatag) self.body.append('') def html_render_png(self, node): image = node.to_drawer('PNG', self.builder) if not os.path.isfile(image.filename): image.draw() image.save() # align if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
') # link to original image relpath = node.get_relpath('PNG', self.builder) if 'width' in node['options'] or 'height' in node['options'] or 'scale' in node['options']: self.body.append('' % relpath) self.context.append('') else: self.context.append('') # tag original_size = image.pagesize() resized = original_size.resize(**node['options']) img_attr = dict(src=relpath, width=resized.width, height=resized.height) if any(node.href for node in image.nodes): img_attr['usemap'] = "#map_%d" % id(image) width_ratio = float(resized.width) / original_size.width height_ratio = float(resized.height) / original_size.height html_render_clickablemap(self, image, width_ratio, height_ratio) if 'alt' in node['options']: img_attr['alt'] = node['options']['alt'] self.body.append(self.starttag(node, 'img', '', empty=True, **img_attr)) @with_blockdiag def html_visit_nwdiag(self, node): try: image_format = get_image_format_for(self.builder) if image_format.upper() == 'SVG': html_render_svg(self, node) else: html_render_png(self, node) except UnicodeEncodeError: if self.builder.config.nwdiag_debug: traceback.print_exc() msg = ("nwdiag error: UnicodeEncodeError caught " "(check your font settings)") logger.warning(msg) raise nodes.SkipNode except Exception as exc: if self.builder.config.nwdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) raise nodes.SkipNode def html_depart_nwdiag(self, node): self.body.append(self.context.pop()) self.body.append(self.context.pop()) def get_image_format_for(builder): if builder.format in ('html', 'slides'): image_format = builder.config.nwdiag_html_image_format.upper() elif builder.format == 'latex': if builder.config.nwdiag_tex_image_format: image_format = builder.config.nwdiag_tex_image_format.upper() else: image_format = builder.config.nwdiag_latex_image_format.upper() else: image_format = 'PNG' if image_format.upper() not in ('PNG', 'PDF', 'SVG'): raise ValueError('unknown format: %s' % image_format) if image_format.upper() == 'PDF': try: import reportlab # NOQA: importing test except ImportError: raise ImportError('Could not output PDF format. Install reportlab.') return image_format def on_builder_inited(self): # show deprecated message if self.builder.config.nwdiag_tex_image_format: logger.warning('nwdiag_tex_image_format is deprecated. Use nwdiag_latex_image_format.') # initialize fontmap global fontmap try: fontmappath = self.builder.config.nwdiag_fontmap fontmap = FontMap(fontmappath) except Exception: fontmap = FontMap(None) try: fontpath = self.builder.config.nwdiag_fontpath if isinstance(fontpath, str): fontpath = [fontpath] if fontpath: config = namedtuple('Config', 'font')(fontpath) fontpath = detectfont(config) fontmap.set_default_font(fontpath) except Exception: pass def on_doctree_resolved(self, doctree, docname): if self.builder.format in ('html', 'slides'): return try: image_format = get_image_format_for(self.builder) except Exception as exc: if self.builder.config.nwdiag_debug: traceback.print_exc() logger.warning('nwdiag error: %s', exc) for node in doctree.traverse(nwdiag_node): node.parent.remove(node) return for node in doctree.traverse(nwdiag_node): try: with Application(): relfn = node.get_relpath(image_format, self.builder) image = node.to_drawer(image_format, self.builder) if not os.path.isfile(image.filename): image.draw() image.save() image = nodes.image(uri=relfn, candidates={'*': relfn}, **node['options']) node.parent.replace(node, image) except Exception as exc: if self.builder.config.nwdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) node.parent.remove(node) def setup(app): app.add_node(nwdiag_node, html=(html_visit_nwdiag, html_depart_nwdiag)) app.add_directive('nwdiag', Nwdiag) app.add_config_value('nwdiag_fontpath', None, 'html') app.add_config_value('nwdiag_fontmap', None, 'html') app.add_config_value('nwdiag_antialias', False, 'html') app.add_config_value('nwdiag_transparency', True, 'html') app.add_config_value('nwdiag_debug', False, 'html') app.add_config_value('nwdiag_html_image_format', 'PNG', 'html') app.add_config_value('nwdiag_tex_image_format', None, 'html') # backward compatibility for 0.6.1 app.add_config_value('nwdiag_latex_image_format', 'PNG', 'html') app.connect("builder-inited", on_builder_inited) app.connect("doctree-resolved", on_doctree_resolved) return { 'version': pkg_resources.require('nwdiag')[0].version, 'parallel_read_safe': True, 'parallel_write_safe': True, } ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997263.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib/packetdiag.py0000644000076600000240000002636300000000000024026 0ustar00tkomiyastaff00000000000000# -*- coding: utf-8 -*- """ packetdiag.sphinx_ext ~~~~~~~~~~~~~~~~~~~~~ Allow packetdiag-formatted diagrams to be included in Sphinx-generated documents inline. :copyright: Copyright 2010 by Takeshi Komiya. :license: BSDL. """ from __future__ import absolute_import import os import re import posixpath import traceback import pkg_resources from collections import namedtuple from docutils import nodes from sphinx import addnodes from sphinx.util import logging from sphinx.util.osutil import ensuredir import packetdiag.utils.rst.nodes import packetdiag.utils.rst.directives from blockdiag.utils.bootstrap import detectfont, Application from blockdiag.utils.fontmap import FontMap from blockdiag.utils.rst.directives import with_blockdiag # fontconfig; it will be initialized on `builder-inited` event. fontmap = None logger = logging.getLogger(__name__) class packetdiag_node(packetdiag.utils.rst.nodes.packetdiag): def to_drawer(self, image_format, builder, **kwargs): if 'filename' in kwargs: filename = kwargs.pop('filename') else: filename = self.get_abspath(image_format, builder) antialias = builder.config.packetdiag_antialias transparency = builder.config.packetdiag_transparency image = super(packetdiag_node, self).to_drawer(image_format, filename, fontmap, antialias=antialias, transparency=transparency, **kwargs) for node in image.diagram.traverse_nodes(): node.href = resolve_reference(builder, node.href) return image def get_relpath(self, image_format, builder): options = dict(antialias=builder.config.packetdiag_antialias, fontpath=builder.config.packetdiag_fontpath, fontmap=builder.config.packetdiag_fontmap, format=image_format, transparency=builder.config.packetdiag_transparency) if hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) or HTML writer outputdir = builder.imgpath else: outputdir = '' return posixpath.join(outputdir, self.get_path(**options)) def get_abspath(self, image_format, builder): options = dict(antialias=builder.config.packetdiag_antialias, fontpath=builder.config.packetdiag_fontpath, fontmap=builder.config.packetdiag_fontmap, format=image_format, transparency=builder.config.packetdiag_transparency) if hasattr(builder, 'imagedir'): # Sphinx (>= 1.3.x) outputdir = os.path.join(builder.outdir, builder.imagedir) elif hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) and HTML writer outputdir = os.path.join(builder.outdir, '_images') else: outputdir = builder.outdir path = os.path.join(outputdir, self.get_path(**options)) ensuredir(os.path.dirname(path)) return path class Packetdiag(packetdiag.utils.rst.directives.PacketdiagDirective): node_class = packetdiag_node def node2image(self, node, diagram): return node def resolve_reference(builder, href): if href is None: return None pattern = re.compile("^:ref:`(.+?)`", re.UNICODE) matched = pattern.search(href) if matched is None: return href elif not hasattr(builder, 'current_docname'): # ex. latex builder return matched.group(1) else: refid = matched.group(1) domain = builder.env.domains['std'] node = addnodes.pending_xref(refexplicit=False) xref = domain.resolve_xref(builder.env, builder.current_docname, builder, 'ref', refid, node, node) if xref: if 'refid' in xref: return "#" + xref['refid'] else: return xref['refuri'] else: logger.warning('undefined label: %s', refid) return None def html_render_svg(self, node): image = node.to_drawer('SVG', self.builder, filename=None, nodoctype=True) image.draw() if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
\n') # reftarget for node_id in node['ids']: self.body.append('' % node_id) # resize image size = image.pagesize().resize(**node['options']) self.body.append(image.save(size)) self.context.append('') def html_render_clickablemap(self, image, width_ratio, height_ratio): href_nodes = [node for node in image.nodes if node.href] if not href_nodes: return self.body.append('' % id(image)) for node in href_nodes: x1, y1, x2, y2 = image.metrics.cell(node) x1 *= width_ratio x2 *= width_ratio y1 *= height_ratio y2 *= height_ratio areatag = '' % (x1, y1, x2, y2, node.href) self.body.append(areatag) self.body.append('') def html_render_png(self, node): image = node.to_drawer('PNG', self.builder) if not os.path.isfile(image.filename): image.draw() image.save() # align if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
') # link to original image relpath = node.get_relpath('PNG', self.builder) if 'width' in node['options'] or 'height' in node['options'] or 'scale' in node['options']: self.body.append('' % relpath) self.context.append('') else: self.context.append('') # tag original_size = image.pagesize() resized = original_size.resize(**node['options']) img_attr = dict(src=relpath, width=resized.width, height=resized.height) if any(node.href for node in image.nodes): img_attr['usemap'] = "#map_%d" % id(image) width_ratio = float(resized.width) / original_size.width height_ratio = float(resized.height) / original_size.height html_render_clickablemap(self, image, width_ratio, height_ratio) if 'alt' in node['options']: img_attr['alt'] = node['options']['alt'] self.body.append(self.starttag(node, 'img', '', empty=True, **img_attr)) @with_blockdiag def html_visit_packetdiag(self, node): try: image_format = get_image_format_for(self.builder) if image_format.upper() == 'SVG': html_render_svg(self, node) else: html_render_png(self, node) except UnicodeEncodeError: if self.builder.config.packetdiag_debug: traceback.print_exc() msg = ("packetdiag error: UnicodeEncodeError caught " "(check your font settings)") logger.warning(msg) raise nodes.SkipNode except Exception as exc: if self.builder.config.packetdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) raise nodes.SkipNode def html_depart_packetdiag(self, node): self.body.append(self.context.pop()) self.body.append(self.context.pop()) def get_image_format_for(builder): if builder.format in ('html', 'slides'): image_format = builder.config.packetdiag_html_image_format.upper() elif builder.format == 'latex': if builder.config.packetdiag_tex_image_format: image_format = builder.config.packetdiag_tex_image_format.upper() else: image_format = builder.config.packetdiag_latex_image_format.upper() else: image_format = 'PNG' if image_format.upper() not in ('PNG', 'PDF', 'SVG'): raise ValueError('unknown format: %s' % image_format) if image_format.upper() == 'PDF': try: import reportlab # NOQA: importing test except ImportError: raise ImportError('Could not output PDF format. Install reportlab.') return image_format def on_builder_inited(self): # show deprecated message if self.builder.config.packetdiag_tex_image_format: logger.warning('packetdiag_tex_image_format is deprecated. Use packetdiag_latex_image_format.') # initialize fontmap global fontmap try: fontmappath = self.builder.config.packetdiag_fontmap fontmap = FontMap(fontmappath) except Exception: fontmap = FontMap(None) try: fontpath = self.builder.config.packetdiag_fontpath if isinstance(fontpath, str): fontpath = [fontpath] if fontpath: config = namedtuple('Config', 'font')(fontpath) fontpath = detectfont(config) fontmap.set_default_font(fontpath) except Exception: pass def on_doctree_resolved(self, doctree, docname): if self.builder.format in ('html', 'slides'): return try: image_format = get_image_format_for(self.builder) except Exception as exc: if self.builder.config.packetdiag_debug: traceback.print_exc() logger.warning('packetdiag error: %s', exc) for node in doctree.traverse(packetdiag_node): node.parent.remove(node) return for node in doctree.traverse(packetdiag_node): try: with Application(): relfn = node.get_relpath(image_format, self.builder) image = node.to_drawer(image_format, self.builder) if not os.path.isfile(image.filename): image.draw() image.save() image = nodes.image(uri=relfn, candidates={'*': relfn}, **node['options']) node.parent.replace(node, image) except Exception as exc: if self.builder.config.packetdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) node.parent.remove(node) def setup(app): app.add_node(packetdiag_node, html=(html_visit_packetdiag, html_depart_packetdiag)) app.add_directive('packetdiag', Packetdiag) app.add_config_value('packetdiag_fontpath', None, 'html') app.add_config_value('packetdiag_fontmap', None, 'html') app.add_config_value('packetdiag_antialias', False, 'html') app.add_config_value('packetdiag_transparency', True, 'html') app.add_config_value('packetdiag_debug', False, 'html') app.add_config_value('packetdiag_html_image_format', 'PNG', 'html') app.add_config_value('packetdiag_tex_image_format', None, 'html') # backward compatibility for 0.6.1 app.add_config_value('packetdiag_latex_image_format', 'PNG', 'html') app.connect("builder-inited", on_builder_inited) app.connect("doctree-resolved", on_doctree_resolved) return { 'version': pkg_resources.require('nwdiag')[0].version, 'parallel_read_safe': True, 'parallel_write_safe': True, } ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997263.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib/rackdiag.py0000644000076600000240000002620200000000000023467 0ustar00tkomiyastaff00000000000000# -*- coding: utf-8 -*- """ rackdiag.sphinx_ext ~~~~~~~~~~~~~~~~~~~~ Allow rackdiag-formatted diagrams to be included in Sphinx-generated documents inline. :copyright: Copyright 2010 by Takeshi Komiya. :license: BSDL. """ from __future__ import absolute_import import os import re import posixpath import traceback import pkg_resources from collections import namedtuple from docutils import nodes from sphinx import addnodes from sphinx.util import logging from sphinx.util.osutil import ensuredir import rackdiag.utils.rst.nodes import rackdiag.utils.rst.directives from blockdiag.utils.bootstrap import detectfont, Application from blockdiag.utils.fontmap import FontMap from blockdiag.utils.rst.directives import with_blockdiag # fontconfig; it will be initialized on `builder-inited` event. fontmap = None logger = logging.getLogger(__name__) class rackdiag_node(rackdiag.utils.rst.nodes.rackdiag): def to_drawer(self, image_format, builder, **kwargs): if 'filename' in kwargs: filename = kwargs.pop('filename') else: filename = self.get_abspath(image_format, builder) antialias = builder.config.rackdiag_antialias transparency = builder.config.rackdiag_transparency image = super(rackdiag_node, self).to_drawer(image_format, filename, fontmap, antialias=antialias, transparency=transparency, **kwargs) for node in image.diagram.traverse_nodes(): node.href = resolve_reference(builder, node.href) return image def get_relpath(self, image_format, builder): options = dict(antialias=builder.config.rackdiag_antialias, fontpath=builder.config.rackdiag_fontpath, fontmap=builder.config.rackdiag_fontmap, format=image_format, transparency=builder.config.rackdiag_transparency) if hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) or HTML writer outputdir = builder.imgpath else: outputdir = '' return posixpath.join(outputdir, self.get_path(**options)) def get_abspath(self, image_format, builder): options = dict(antialias=builder.config.rackdiag_antialias, fontpath=builder.config.rackdiag_fontpath, fontmap=builder.config.rackdiag_fontmap, format=image_format, transparency=builder.config.rackdiag_transparency) if hasattr(builder, 'imagedir'): # Sphinx (>= 1.3.x) outputdir = os.path.join(builder.outdir, builder.imagedir) elif hasattr(builder, 'imgpath'): # Sphinx (<= 1.2.x) and HTML writer outputdir = os.path.join(builder.outdir, '_images') else: outputdir = builder.outdir path = os.path.join(outputdir, self.get_path(**options)) ensuredir(os.path.dirname(path)) return path class Rackdiag(rackdiag.utils.rst.directives.RackdiagDirective): node_class = rackdiag_node def node2image(self, node, diagram): return node def resolve_reference(builder, href): if href is None: return None pattern = re.compile("^:ref:`(.+?)`", re.UNICODE) matched = pattern.search(href) if matched is None: return href elif not hasattr(builder, 'current_docname'): # ex. latex builder return matched.group(1) else: refid = matched.group(1) domain = builder.env.domains['std'] node = addnodes.pending_xref(refexplicit=False) xref = domain.resolve_xref(builder.env, builder.current_docname, builder, 'ref', refid, node, node) if xref: if 'refid' in xref: return "#" + xref['refid'] else: return xref['refuri'] else: logger.warning('undefined label: %s', refid) return None def html_render_svg(self, node): image = node.to_drawer('SVG', self.builder, filename=None, nodoctype=True) image.draw() if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
\n') # reftarget for node_id in node['ids']: self.body.append('' % node_id) # resize image size = image.pagesize().resize(**node['options']) self.body.append(image.save(size)) self.context.append('') def html_render_clickablemap(self, image, width_ratio, height_ratio): href_nodes = [node for node in image.nodes if node.href] if not href_nodes: return self.body.append('' % id(image)) for node in href_nodes: x1, y1, x2, y2 = image.metrics.cell(node) x1 *= width_ratio x2 *= width_ratio y1 *= height_ratio y2 *= height_ratio areatag = '' % (x1, y1, x2, y2, node.href) self.body.append(areatag) self.body.append('') def html_render_png(self, node): image = node.to_drawer('PNG', self.builder) if not os.path.isfile(image.filename): image.draw() image.save() # align if 'align' in node['options']: align = node['options']['align'] self.body.append('
' % (align, align)) self.context.append('
\n') else: self.body.append('
') self.context.append('
') # link to original image relpath = node.get_relpath('PNG', self.builder) if 'width' in node['options'] or 'height' in node['options'] or 'scale' in node['options']: self.body.append('' % relpath) self.context.append('') else: self.context.append('') # tag original_size = image.pagesize() resized = original_size.resize(**node['options']) img_attr = dict(src=relpath, width=resized.width, height=resized.height) if any(node.href for node in image.nodes): img_attr['usemap'] = "#map_%d" % id(image) width_ratio = float(resized.width) / original_size.width height_ratio = float(resized.height) / original_size.height html_render_clickablemap(self, image, width_ratio, height_ratio) if 'alt' in node['options']: img_attr['alt'] = node['options']['alt'] self.body.append(self.starttag(node, 'img', '', empty=True, **img_attr)) @with_blockdiag def html_visit_rackdiag(self, node): try: image_format = get_image_format_for(self.builder) if image_format.upper() == 'SVG': html_render_svg(self, node) else: html_render_png(self, node) except UnicodeEncodeError: if self.builder.config.rackdiag_debug: traceback.print_exc() msg = ("rackdiag error: UnicodeEncodeError caught " "(check your font settings)") logger.warning(msg) raise nodes.SkipNode except Exception as exc: if self.builder.config.rackdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) raise nodes.SkipNode def html_depart_rackdiag(self, node): self.body.append(self.context.pop()) self.body.append(self.context.pop()) def get_image_format_for(builder): if builder.format in ('html', 'slides'): image_format = builder.config.rackdiag_html_image_format.upper() elif builder.format == 'latex': if builder.config.rackdiag_tex_image_format: image_format = builder.config.rackdiag_tex_image_format.upper() else: image_format = builder.config.rackdiag_latex_image_format.upper() else: image_format = 'PNG' if image_format.upper() not in ('PNG', 'PDF', 'SVG'): raise ValueError('unknown format: %s' % image_format) if image_format.upper() == 'PDF': try: import reportlab # NOQA: importing test except ImportError: raise ImportError('Could not output PDF format. Install reportlab.') return image_format def on_builder_inited(self): # show deprecated message if self.builder.config.rackdiag_tex_image_format: logger.warning('rackdiag_tex_image_format is deprecated. Use rackdiag_latex_image_format.') # initialize fontmap global fontmap try: fontmappath = self.builder.config.rackdiag_fontmap fontmap = FontMap(fontmappath) except Exception: fontmap = FontMap(None) try: fontpath = self.builder.config.rackdiag_fontpath if isinstance(fontpath, str): fontpath = [fontpath] if fontpath: config = namedtuple('Config', 'font')(fontpath) fontpath = detectfont(config) fontmap.set_default_font(fontpath) except Exception: pass def on_doctree_resolved(self, doctree, docname): if self.builder.format in ('html', 'slides'): return try: image_format = get_image_format_for(self.builder) except Exception as exc: if self.builder.config.rackdiag_debug: traceback.print_exc() logger.warning('rackdiag error: %s', exc) for node in doctree.traverse(rackdiag_node): node.parent.remove(node) return for node in doctree.traverse(rackdiag_node): try: with Application(): relfn = node.get_relpath(image_format, self.builder) image = node.to_drawer(image_format, self.builder) if not os.path.isfile(image.filename): image.draw() image.save() image = nodes.image(uri=relfn, candidates={'*': relfn}, **node['options']) node.parent.replace(node, image) except Exception as exc: if self.builder.config.rackdiag_debug: traceback.print_exc() logger.warning('dot code %r: %s', node['code'], exc) node.parent.remove(node) def setup(app): app.add_node(rackdiag_node, html=(html_visit_rackdiag, html_depart_rackdiag)) app.add_directive('rackdiag', Rackdiag) app.add_config_value('rackdiag_fontpath', None, 'html') app.add_config_value('rackdiag_fontmap', None, 'html') app.add_config_value('rackdiag_antialias', False, 'html') app.add_config_value('rackdiag_transparency', True, 'html') app.add_config_value('rackdiag_debug', False, 'html') app.add_config_value('rackdiag_html_image_format', 'PNG', 'html') app.add_config_value('rackdiag_tex_image_format', None, 'html') # backward compatibility for 0.6.1 app.add_config_value('rackdiag_latex_image_format', 'PNG', 'html') app.connect("builder-inited", on_builder_inited) app.connect("doctree-resolved", on_doctree_resolved) return { 'version': pkg_resources.require('nwdiag')[0].version, 'parallel_read_safe': True, 'parallel_write_safe': True, } ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1575997324.896478 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/0000755000076600000240000000000000000000000024371 5ustar00tkomiyastaff00000000000000././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/PKG-INFO0000644000076600000240000000501600000000000025470 0ustar00tkomiyastaff00000000000000Metadata-Version: 1.1 Name: sphinxcontrib-nwdiag Version: 2.0.0 Summary: Sphinx "nwdiag" extension Home-page: http://github.com/blockdiag/sphinxcontrib-nwdiag Author: Takeshi KOMIYA Author-email: i.tkomiya@gmail.com License: BSD Description: ==================== sphinxcontrib-nwdiag ==================== .. image:: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag.svg?branch=master :target: https://travis-ci.org/blockdiag/sphinxcontrib-nwdiag .. image:: https://coveralls.io/repos/blockdiag/sphinxcontrib-nwdiag/badge.png?branch=master :target: https://coveralls.io/r/blockdiag/sphinxcontrib-nwdiag?branch=master .. image:: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag/badges/gpa.svg :target: https://codeclimate.com/github/blockdiag/sphinxcontrib-nwdiag A sphinx extension for embedding network related diagrams using nwdiag_. For now, nwdiag supports these diagrams: - logical network diagram - rack structure diagram - packet structure diagram This extension enables you to insert network related diagrams into your document. Following code is an example:: .. nwdiag:: nwdiag { network { web01; web02; } network { web01; web02; db01; } } .. _nwdiag: http://bitbucket.org/blockdiag/nwdiag/ For more details, see `online documentation`_ at http://blockdiag.com/. .. _online documentation: http://blockdiag.com/en/nwdiag/sphinxcontrib.html Platform: any Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Environment :: Web Environment Classifier: Framework :: Sphinx :: Extension Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3 :: Only Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Topic :: Documentation Classifier: Topic :: Documentation :: Sphinx Classifier: Topic :: Utilities ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/SOURCES.txt0000644000076600000240000000073400000000000026261 0ustar00tkomiyastaff00000000000000AUTHORS LICENSE MANIFEST.in README.rst setup.cfg setup.py sphinxcontrib/__init__.py sphinxcontrib/nwdiag.py sphinxcontrib/packetdiag.py sphinxcontrib/rackdiag.py sphinxcontrib_nwdiag.egg-info/PKG-INFO sphinxcontrib_nwdiag.egg-info/SOURCES.txt sphinxcontrib_nwdiag.egg-info/dependency_links.txt sphinxcontrib_nwdiag.egg-info/namespace_packages.txt sphinxcontrib_nwdiag.egg-info/not-zip-safe sphinxcontrib_nwdiag.egg-info/requires.txt sphinxcontrib_nwdiag.egg-info/top_level.txt././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/dependency_links.txt0000644000076600000240000000000100000000000030437 0ustar00tkomiyastaff00000000000000 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/namespace_packages.txt0000644000076600000240000000001600000000000030721 0ustar00tkomiyastaff00000000000000sphinxcontrib ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575823841.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/not-zip-safe0000644000076600000240000000000100000000000026617 0ustar00tkomiyastaff00000000000000 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/requires.txt0000644000076600000240000000005300000000000026767 0ustar00tkomiyastaff00000000000000blockdiag>=1.5.0 nwdiag>=1.0.3 Sphinx>=2.0 ././@PaxHeader0000000000000000000000000000002600000000000011453 xustar000000000000000022 mtime=1575997324.0 sphinxcontrib-nwdiag-2.0.0/sphinxcontrib_nwdiag.egg-info/top_level.txt0000644000076600000240000000001600000000000027120 0ustar00tkomiyastaff00000000000000sphinxcontrib