{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/9"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"A Sphinx extension that executes arbitrary shell commands and embeds their output directly into reStructuredText documentation, with options for syntax highlighting, text replacement, and prompt display.","skillfed_tags":["sphinx-extension","documentation-automation","command-execution"],"use_cases":["Documenting CLI tools by running them with --help and embedding the actual output in your docs.","Keeping API documentation examples current by executing test scripts and showing their real output.","Building tutorials where command results need to stay synchronized with the actual tool behavior.","Generating reference documentation that includes real command output without manual copying.","Creating reproducible documentation where the build process verifies that examples actually work."],"what_it_does":"sphinxcontrib-runcmd is a Sphinx extension that lets you run shell commands during documentation builds and automatically insert their output into your reStructuredText files. Instead of manually copying command output into your docs, you write a directive with the command you want to run, and the extension executes it and captures the result. It builds on Sphinx's standard code-block directive, so you get all the usual formatting options like line numbers, syntax highlighting, and line ranges.\n\nThe extension adds several options beyond code-block: you can specify output syntax highlighting separately from the command, display the command prompt itself, dedent output, and apply regex-based text replacements to clean up or anonymize the output. This makes it useful for keeping documentation in sync with actual tool behavior without manual updates.","worth_installing":"Yes, if you maintain Sphinx documentation and want to keep command output examples in sync with reality. The low install friction and permissive license make it a safe addition. However, the aging codebase (last release 2018) means you should verify compatibility with your Python version and Sphinx version before relying on it for critical docs. No known security vulnerabilities."},"id":"sphinxcontrib-runcmd","links":{"html":"https://skillfed.io/packages/sphinxcontrib-runcmd","md":"https://skillfed.io/packages/sphinxcontrib-runcmd.md","pypi":"https://pypi.org/project/sphinxcontrib-runcmd/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2018-11-08","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-runcmd","python_support":"unspecified","summary":"Sphinx \"runcmd\" extension"},"popularity":{"monthly_downloads":135786,"position":11418,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.2.0"}