{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/7"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"A Sphinx extension that executes arbitrary shell commands and embeds their output directly into documentation, keeping command examples synchronized with actual program behavior.","skillfed_tags":["sphinx-extension","documentation-automation","cli-docs"],"use_cases":["Keep CLI tool help text and version output in documentation automatically synchronized with the actual program.","Generate documentation examples by running code snippets and embedding their output without manual copy-paste.","Verify that documented command examples produce the expected output during every documentation build.","Create shell session tutorials that show both the command and its real output without manual formatting.","Maintain API or tool documentation where examples must reflect the current behavior of the software."],"what_it_does":"sphinxcontrib-programoutput is a Sphinx extension that runs shell commands during documentation builds and inserts their output directly into the generated docs. It provides two directives: `program-output` to embed raw command output, and `command-output` to show shell session examples with prompts. This is useful for keeping documentation examples synchronized with actual program behavior\u2014when the program's output changes, the docs update automatically on the next build.\n\nThe extension depends only on Sphinx and docutils, making it lightweight to install. It's actively maintained, supports modern Python versions (3.10 through 3.14), and runs on both CPython and PyPy. The BSD-2-Clause license places no significant restrictions on use.","worth_installing":"Yes. Low install friction, no security vulnerabilities, permissive license, and active maintenance. Install if you maintain Sphinx documentation for CLI tools, libraries, or examples where keeping output synchronized with actual behavior matters. The only gotcha is that command execution happens during builds, so only enable this for documentation sources you trust."},"id":"sphinxcontrib-programoutput","links":{"html":"https://skillfed.io/packages/sphinxcontrib-programoutput","md":"https://skillfed.io/packages/sphinxcontrib-programoutput.md","pypi":"https://pypi.org/project/sphinxcontrib-programoutput/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-06-16","license_spdx":"BSD-2-Clause","license_treatment":"permissive","name":"sphinxcontrib-programoutput","python_support":"supports_current","summary":"Sphinx extension to include program output"},"popularity":{"monthly_downloads":263522,"position":8355,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.20"}