{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that embeds draw.io diagrams into documentation by converting .drawio files to image formats (PNG, JPG, SVG, PDF) during the build process.","skillfed_tags":["sphinx-extension","diagram-automation","documentation-tooling"],"use_cases":["Maintain architecture diagrams, flowcharts, and UX mockups in draw.io and auto-export them to your Sphinx HTML/PDF documentation on each build.","Configure different export formats per Sphinx builder (SVG for web, PDF for print) without editing source files.","Scale diagrams to higher resolution for print output using the export-scale option.","Include multi-page draw.io files and select specific pages by index or name for different sections of your docs.","Run diagram export in CI/CD pipelines with headless mode and Xvfb for automated documentation builds."],"what_it_does":"sphinxcontrib-drawio is a Sphinx extension that lets you include draw.io diagrams directly in your documentation source. Instead of manually exporting diagrams to PNG or SVG and committing static images, you reference .drawio files in your reStructuredText using the drawio-image or drawio-figure directives, and the extension automatically exports them to your chosen format during the Sphinx build. It wraps the draw.io CLI tool and handles the mechanics of invoking it with the right options.\n\nThe extension is designed for projects that maintain diagrams in draw.io's native format and want those diagrams to stay in version control alongside the documentation source. It supports per-diagram export settings (format, scale, transparency, page selection) and builder-specific defaults, so you can export to SVG for HTML builds and PDF for LaTeX builds without duplicating directives. The main constraint is that it requires the draw.io desktop binary to be installed on the build machine, and on headless systems (CI, Docker) you need to configure virtual framebuffer support.","worth_installing":"Yes, if you actively maintain diagrams in draw.io and want them version-controlled and auto-exported in your Sphinx docs. The extension is stable, actively maintained, has no security issues, and low install friction. The main gotcha is the external draw.io binary dependency and headless-mode setup on CI\u2014plan for that upfront. Not suitable for Read the Docs hosting."},"id":"sphinxcontrib-drawio","links":{"html":"https://skillfed.io/packages/sphinxcontrib-drawio","md":"https://skillfed.io/packages/sphinxcontrib-drawio.md","pypi":"https://pypi.org/project/sphinxcontrib-drawio/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2023-09-12","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-drawio","python_support":"supports_current","summary":"Sphinx Extension to include draw.io files"},"popularity":{"monthly_downloads":87467,"position":13795,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.0.17"}