{ "info": { "author": "Sebastian Wiesner", "author_email": "lunaryorn@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Sphinx", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Documentation", "Topic :: Utilities" ], "description": "=============================\n sphinxcontrib-programoutput\n=============================\n\n.. image:: https://secure.travis-ci.org/NextThought/sphinxcontrib-programoutput.png\n :target: http://travis-ci.org/NextThought/sphinxcontrib-programoutput\n\n.. image:: https://coveralls.io/repos/github/NextThought/sphinxcontrib-programoutput/badge.svg\n :target: https://coveralls.io/github/NextThought/sphinxcontrib-programoutput\n\n\nhttps://sphinxcontrib-programoutput.readthedocs.org\n\nA Sphinx_ extension to literally insert the output of arbitrary commands into\ndocuments, helping you to keep your command examples up to date.\n\n\nInstallation\n============\n\nInstall this extension from PyPI_::\n\n pip install sphinxcontrib-programoutput\n\nThe extension requires Sphinx 1.7.0 and Python 2.7 or Python 3 (Python\n3.5+ is tested) at least.\n\nUsage\n=====\n\nJust add this extension to ``extensions``::\n\n extensions = ['sphinxcontrib.programoutput']\n\nNow you've two new directives ``program-output`` and ``command-output`` to\ninsert the output of programs. The former just inserts the output::\n\n .. program-output:: python -V\n\nOutput::\n\n Python 2.7.1\n\nThe latter directive mimics a shell session, and is intended to show examples::\n\n .. command-output:: python -V\n\nOutput::\n\n $ python -V\n Python 2.7.1\n\n\nPlease refer to the documentation_ for comprehensive information about usage and\nconfiguration of this extension.\n\n\nDevelopment and Support\n=======================\n\nPlease refer to the documentation_ for information on support and the\ndevelopment process.\n\n\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/\n.. _PyPI: http://pypi.python.org/pypi/sphinxcontrib-programoutput\n.. _documentation: http://sphinxcontrib-programoutput.readthedocs.org\n\n\n=========\n Changes\n=========\n\n0.15 (2019-09-16)\n=================\n\n- Make the test suite stop assuming the presence of a 'python'\n executable on the path. Instead it uses ``sys.executable`` (which\n shouldn't have spaces). Note that it does continue to assume the\n presence of other executables, such as 'echo'. Reported in `issue 38\n `_\n by John Vandenberg.\n\n\n0.14 (2019-04-08)\n=================\n\n- Add ``python_requires`` metadata to better allow tools like ``pip``\n to install a correct version.\n\n- Add support for Sphinx 2.0 on Python 3.\n\n- Avoid unicode errors when the program command or output produced\n non-ASCII output and the configured prompt was a byte string. This\n was most likely under Python 2, where the default configured prompt\n is a byte string. Reported by, and patch inspired by, `issue 33\n `_\n by latricewilgus.\n\n0.13 (2018-12-22)\n=================\n\n- Drop support for Sphinx < 1.7.\n\n- Fix tests on Sphinx >= 1.8.0.\n\n- Restore error message into the document by default from failed\n program runs on Sphinx >= 1.8.0b1.\n\n- Fix deprecation warnings on Sphinx >= 1.8. Reported in `issue 29\n `_\n by miili.\n\n\n0.11 (2017-05-18)\n=================\n\n- Explicitly set ``parallel_read_safe`` to true in the extension\n metadata. See `issue 25\n `_.\n With thanks to Adam J. Stewart and Stephen McDowell.\n\n0.10 (2017-03-17)\n=================\n\n- Decode output from the program tolerantly, using the 'replace'\n handler. Based on a `pull request\n `_\n by Stefan C. M\u00fcller.\n\n\n0.9 (2017-03-15)\n================\n\n- Forked and revived the project in `Gitub\n `_.\n\n- Run the tests on Travis CI. Formatting and style is enforced by pylint.\n\n- The oldest supported and tested Sphinx version is now 1.3.5. See\n `issue 17\n `_.\n\n\n- Remove support for Python 2.6, Python 3.2 and 3.3.\n\n- 100% test coverage.\n\n- Remove support for ``programoutput_use_ansi``. The\n ``sphinxcontrib.ansi`` extension is no longer available on PyPI.\n\n0.8 (Oct 12, 2012)\n==================\n\n- Migrated to GitHub\n\n\n0.7 (Apr 17, 2012)\n==================\n\n- Added ``cwd`` option to ``..program-output``\n- Working directory of executed programs defaults to documentation root now\n\n\n0.6 (Jan 07, 2012)\n==================\n\n- Python 3 support\n- Require Sphinx 1.1 now\n\n\n0.5 (Sep 19, 2011)\n==================\n\n- ``programoutput_prompt_template`` is interpreted as format string now!\n- Require Python 2.6 now\n- Added ``returncode`` option to ``program-output`` (thanks to\n Jan-Marek Glogowski)\n- Support ``returncode`` formatting key in\n ``programoutput_prompt_template``\n- Warn on unexpected return codes instead of raising\n ``subprocess.CalledProcessError``\n- Turn fatal errors during command into document error messages\n instead of crashing the build\n\n\n0.4.1 (Mar 11, 2011)\n====================\n\n- Some source code cleanups\n- Fixed installation instructions in documentation\n\n\n0.4 (May 21, 2010)\n==================\n\n- Initial release\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://sphinxcontrib-programoutput.readthedocs.org/", "keywords": "sphinx cli command output program example", "license": "BSD", "maintainer": "Jason Madden", "maintainer_email": "jason@nextthought.com", "name": "sphinxcontrib-programoutput", "package_url": "https://pypi.org/project/sphinxcontrib-programoutput/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-programoutput/", "project_urls": { "Homepage": "https://sphinxcontrib-programoutput.readthedocs.org/" }, "release_url": "https://pypi.org/project/sphinxcontrib-programoutput/0.15/", "requires_dist": [ "Sphinx (>=1.7.0)" ], "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "summary": "Sphinx extension to include program output", "version": "0.15" }, "last_serial": 5835684, "releases": { "0.10": [ { "comment_text": "", "digests": { "md5": "fe176bd233d9ce238c95fdcaa8bdbefc", "sha256": "9d665ece29627d87b7e3b678bbba4007f147de0ee27418c66b6128329b0c49ad" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.10-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fe176bd233d9ce238c95fdcaa8bdbefc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18953, "upload_time": "2017-03-17T15:40:37", "url": "https://files.pythonhosted.org/packages/c2/70/addc3e19a10558d378ec59e5c00f7c5605ac4e5b09a4f6ef32b62ae0b53d/sphinxcontrib_programoutput-0.10-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8e511e476c67696c7ae2c08b15644eb4", "sha256": "fdee94fcebb0d8fddfccac5c4fa560f6177d5340c4349ee447c890bea8857094" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.10.tar.gz", "has_sig": false, "md5_digest": "8e511e476c67696c7ae2c08b15644eb4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18102, "upload_time": "2017-03-17T15:40:42", "url": "https://files.pythonhosted.org/packages/aa/e1/2a999a0dc384928356e53ba3ec9461a928e75ba1d26c6cc4a2173b76ce17/sphinxcontrib-programoutput-0.10.tar.gz" } ], "0.11": [ { "comment_text": "", "digests": { "md5": "041501eb0d6184a60ae43e147b403b5c", "sha256": "bd47ff0e1cddec82e1d4501f6f0fa3f77481765fcc7c58ec685ef05b44386c40" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.11-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "041501eb0d6184a60ae43e147b403b5c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 19026, "upload_time": "2017-05-18T16:36:43", "url": "https://files.pythonhosted.org/packages/13/10/e344bc652e13273cfd9e422b31c07aa5439960d8839d07236c21b7b7e58a/sphinxcontrib_programoutput-0.11-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "564cc08f157d1f964b85ca598363f928", "sha256": "cbec3ee1c3abd09e105115ab69cb5ade8ca1be9811565a844f973e93e0314837" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.11.tar.gz", "has_sig": false, "md5_digest": "564cc08f157d1f964b85ca598363f928", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18267, "upload_time": "2017-05-18T16:36:41", "url": "https://files.pythonhosted.org/packages/25/34/fd1b61d3fe9ea705dff169d55426bf23d8be0f7b1976d17e79fbcc16e7d9/sphinxcontrib-programoutput-0.11.tar.gz" } ], "0.13": [ { "comment_text": "", "digests": { "md5": "ae5c5152420fa6a5cf5335e7b0d14252", "sha256": "d8466fcefa2d9d5219bcc5a2ff22eff07b8e808eaca7f3abc208e84d38ddec7b" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.13-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ae5c5152420fa6a5cf5335e7b0d14252", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18560, "upload_time": "2018-12-22T23:35:36", "url": "https://files.pythonhosted.org/packages/f6/4a/13735911ce71ad5ae60be282df260877a5de95fcf5cd63090c67b6ddf0c7/sphinxcontrib_programoutput-0.13-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "21f4d0079441c6e97385b1ea2b47ba12", "sha256": "793f82618cf260da66c766923eeba387d18226afb647c9cd9e47825f74c2f514" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.13.tar.gz", "has_sig": false, "md5_digest": "21f4d0079441c6e97385b1ea2b47ba12", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18431, "upload_time": "2018-12-22T23:35:35", "url": "https://files.pythonhosted.org/packages/be/08/db26a372785a4eaebad287c9557345e606785af7af886c3fd4e368d494eb/sphinxcontrib-programoutput-0.13.tar.gz" } ], "0.14": [ { "comment_text": "", "digests": { "md5": "a0cc884cb41602b634c5146f6329cf1e", "sha256": "55678c7f81e96df48e9f0d97a48ebf84ad9f659bc86ed27e7b0d656c050569b7" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.14-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a0cc884cb41602b634c5146f6329cf1e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 20776, "upload_time": "2019-04-08T18:00:38", "url": "https://files.pythonhosted.org/packages/36/49/3d786e7cd0dc1994e25e3fab415be3984a6b07c883db5a91913005f38751/sphinxcontrib_programoutput-0.14-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9eeb8b4927b12b81a8a30f80950c67f3", "sha256": "75b182e9e8cf7efe828cac2c351bb737b00a76bc3aa60fd1a9b2b7096e99c383" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.14.tar.gz", "has_sig": false, "md5_digest": "9eeb8b4927b12b81a8a30f80950c67f3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 21398, "upload_time": "2019-04-08T18:00:36", "url": "https://files.pythonhosted.org/packages/8b/85/3dc8530f0e95a2961935cccd957da25c572894ecd746f30006d6bc6b1e9d/sphinxcontrib-programoutput-0.14.tar.gz" } ], "0.15": [ { "comment_text": "", "digests": { "md5": "a0e6078b95c7fd2b918131ce3f1fa38e", "sha256": "8a15af67546c35404a02e0ad13c0a9ded0d587393fca5fa637a467bfee1222f0" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.15-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a0e6078b95c7fd2b918131ce3f1fa38e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 21131, "upload_time": "2019-09-16T11:37:43", "url": "https://files.pythonhosted.org/packages/34/22/c14806fa02f3a5dd9ebe21fcbd378555a7f0462689895c3fe4d61b9d1e1c/sphinxcontrib_programoutput-0.15-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "797140fbf06b930862d8d78730e54e77", "sha256": "80dd5b4eab780a13ff2c23500cac3dbf0e04ef9976b409ef25a47c263ef8ab94" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.15.tar.gz", "has_sig": false, "md5_digest": "797140fbf06b930862d8d78730e54e77", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 21772, "upload_time": "2019-09-16T11:37:45", "url": "https://files.pythonhosted.org/packages/fd/f5/88a33c39e4e6409a32c6e5211e5397618df7d95dcc354b4a24f7930455a1/sphinxcontrib-programoutput-0.15.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "eff2c7a527c9581d23c7f589a8a13b6f", "sha256": "5e36f487fbddd4f6cf1949ab336f1ed0a692dc623b29dc72573d54a1d76d6b29" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.8-cp27-none-any.whl", "has_sig": false, "md5_digest": "eff2c7a527c9581d23c7f589a8a13b6f", "packagetype": "bdist_wheel", "python_version": "cp27", "requires_python": null, "size": 8984, "upload_time": "2016-11-01T13:03:33", "url": "https://files.pythonhosted.org/packages/70/33/6b565d47f8543f018b8026e104c1fb63785af3ba85120de93cee70c3d36e/sphinxcontrib_programoutput-0.8-cp27-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fbe20e52445520b6eb6e5f984f3f24e7", "sha256": "946b1fc839461abbce19a32d1b21fc922cca7e4be5ee094d15f9fad1cbef21d6" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.8-cp35-none-any.whl", "has_sig": false, "md5_digest": "fbe20e52445520b6eb6e5f984f3f24e7", "packagetype": "bdist_wheel", "python_version": "cp35", "requires_python": null, "size": 8983, "upload_time": "2016-11-01T13:03:52", "url": "https://files.pythonhosted.org/packages/5e/d4/ccc1ab3ce03f3b24a9b496cdee7166d48f24d60211506382ee4816e67ee1/sphinxcontrib_programoutput-0.8-cp35-none-any.whl" }, { "comment_text": "", "digests": { "md5": "125e203920a1f71a5ce792998f72bac6", "sha256": "8220004935e1f5e68e5201eb4e9a400df73d8570f70044491715324cffa33fbe" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "125e203920a1f71a5ce792998f72bac6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8979, "upload_time": "2016-11-02T12:14:28", "url": "https://files.pythonhosted.org/packages/f0/ce/205bc4b721002f441dd2428908d09c91d167cc4165ccdbb8275521cc97ff/sphinxcontrib_programoutput-0.8-py3-none-any.whl" } ], "0.8.dev20161101": [] }, "urls": [ { "comment_text": "", "digests": { "md5": "a0e6078b95c7fd2b918131ce3f1fa38e", "sha256": "8a15af67546c35404a02e0ad13c0a9ded0d587393fca5fa637a467bfee1222f0" }, "downloads": -1, "filename": "sphinxcontrib_programoutput-0.15-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a0e6078b95c7fd2b918131ce3f1fa38e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 21131, "upload_time": "2019-09-16T11:37:43", "url": "https://files.pythonhosted.org/packages/34/22/c14806fa02f3a5dd9ebe21fcbd378555a7f0462689895c3fe4d61b9d1e1c/sphinxcontrib_programoutput-0.15-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "797140fbf06b930862d8d78730e54e77", "sha256": "80dd5b4eab780a13ff2c23500cac3dbf0e04ef9976b409ef25a47c263ef8ab94" }, "downloads": -1, "filename": "sphinxcontrib-programoutput-0.15.tar.gz", "has_sig": false, "md5_digest": "797140fbf06b930862d8d78730e54e77", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*", "size": 21772, "upload_time": "2019-09-16T11:37:45", "url": "https://files.pythonhosted.org/packages/fd/f5/88a33c39e4e6409a32c6e5211e5397618df7d95dcc354b4a24f7930455a1/sphinxcontrib-programoutput-0.15.tar.gz" } ] }