{"library":"sphinxcontrib-runcmd","title":"sphinxcontrib-runcmd","type":"library","description":"A Sphinx extension that allows running shell commands and including their output in documentation. Version 0.2.0 (latest), stable release. No breaking changes reported.","language":"python","status":"active","last_verified":"Fri May 01","install":{"commands":["pip install sphinxcontrib-runcmd"],"cli":null},"imports":["from sphinxcontrib.runcmd import runcmd"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/invenia/sphinxcontrib-runcmd","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinxcontrib-runcmd/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import sphinxcontrib.runcmd\n\n# In conf.py:\nextensions = ['sphinxcontrib.runcmd']\n\n# Then in your .rst files:\n# .. runcmd:: echo 'Hello World'\n#    :shell:\n#    :workdir: /tmp","lang":"python","description":"Add the extension to your Sphinx project and use the runcmd directive.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}