{"library":"sphinxcontrib-programoutput","title":"Sphinx Program Output Extension","type":"library","description":"sphinxcontrib-programoutput is a Sphinx extension that enables the literal insertion of arbitrary command output into documentation. This helps maintain up-to-date command examples. The current version is 0.19, with releases occurring on an irregular but active cadence, most recently in February 2026.","language":"python","status":"active","last_verified":"Mon May 18","install":{"commands":["pip install sphinxcontrib-programoutput"],"cli":null},"imports":["extensions = ['sphinxcontrib.programoutput'] # in conf.py"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://sphinxcontrib-programoutput.readthedocs.io/en/latest/","github":"https://github.com/OpenNTI/sphinxcontrib-programoutput","docs":"https://sphinxcontrib-programoutput.readthedocs.io/en/latest/","changelog":"https://github.com/OpenNTI/sphinxcontrib-programoutput/blob/master/CHANGES.rst","pypi":"https://pypi.org/project/sphinxcontrib-programoutput/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinxcontrib.programoutput'\n]\n\n# Your_Document.rst\n\n.. program-output:: python -V\n   :shell:\n\n.. command-output:: python -c \"print('Hello from Python!')\"\n\n# Example with options\n.. program-output:: git log -1\n   :cwd: .\n   :ellipsis: 2,-1\n","lang":"python","description":"After installation, enable the extension by adding 'sphinxcontrib.programoutput' to the `extensions` list in your Sphinx `conf.py`. Then, use the `.. program-output::` or `.. command-output::` reStructuredText directives in your documentation files to include command output. `command-output` mimics a shell session, including the command itself. Options like `cwd` (current working directory), `ellipsis` (to shorten output), `nostderr` (to hide stderr), `shell` (to pass command to system shell), and `returncode` (to expect specific exit codes) are available.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-18","installed_version":"0.19","pypi_latest":"0.19","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.4,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.2M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"101.5M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.3,"import_time_s":null,"mem_mb":null,"disk_size":"102M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.4M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.1,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.3M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"91.6M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinxcontrib-programoutput","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.2,"import_time_s":null,"mem_mb":null,"disk_size":"92M"}]}}