============================
sphinxcontrib-programoutput2
============================
https://sphinxcontrib-programoutput2.readthedocs.org
A Sphinx_ extension to literally insert the output of arbitrary commands into
documents, helping you to keep your command examples up to date.
Installation
============
Install this extension from PyPI_::
pip install sphinxcontrib-programoutput2
The extension requires Sphinx 3.0.0 and Python 3.6 or newer.
Usage
=====
Just add this extension to ``extensions``::
extensions = ['sphinxcontrib.programoutput']
Now you've two new directives ``program-output`` and ``command-output`` to
insert the output of programs. The former just inserts the output::
.. program-output:: python -V
Output::
Python 3.9.0
The latter directive mimics a shell session, and is intended to show examples::
.. command-output:: python -V
Output::
$ python -V
Python 3.9.0
Please refer to the documentation_ for comprehensive information about usage and
configuration of this extension.
Development and Support
=======================
Please refer to the documentation_ for information on support and the
development process.
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _PyPI: http://pypi.python.org/pypi/sphinxcontrib-programoutput2
.. _documentation: http://sphinxcontrib-programoutput2.readthedocs.org
Raw data
{
"_id": null,
"home_page": "https://sphinxcontrib-programoutput2.readthedocs.org/",
"name": "sphinxcontrib-programoutput2",
"maintainer": "Sorin Sbarnea",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "sorin.sbarnea@gmail.com",
"keywords": "sphinx,cli,command,output,program,example",
"author": "Sebastian Wiesner",
"author_email": "lunaryorn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/dc/9781d6b6c5d958ab1acb63a218af2d6acc23e92cbef460a03d03ec64dffc/sphinxcontrib-programoutput2-2.0a1.tar.gz",
"platform": "",
"description": "============================\nsphinxcontrib-programoutput2\n============================\n\n\nhttps://sphinxcontrib-programoutput2.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-programoutput2\n\nThe extension requires Sphinx 3.0.0 and Python 3.6 or newer.\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 3.9.0\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 3.9.0\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-programoutput2\n.. _documentation: http://sphinxcontrib-programoutput2.readthedocs.org\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Sphinx extension to include program output",
"version": "2.0a1",
"split_keywords": [
"sphinx",
"cli",
"command",
"output",
"program",
"example"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f5aad35109c93368ef36970bb7882fc3",
"sha256": "466e6aeeaca10e3dd07582664e42904dfd88329b6c4c4b98dc78715e9b44a0a1"
},
"downloads": -1,
"filename": "sphinxcontrib_programoutput2-2.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5aad35109c93368ef36970bb7882fc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25552,
"upload_time": "2021-03-11T15:57:29",
"upload_time_iso_8601": "2021-03-11T15:57:29.493543Z",
"url": "https://files.pythonhosted.org/packages/e6/db/5abb82d6195ecaa3e6f024a2426259ebcb3db62689163a6a47c8a01dda87/sphinxcontrib_programoutput2-2.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "6fd1c5ce9996e5be72541620079dfe6f",
"sha256": "aa8e17aaa2c8a43e134217d115b8c38a994c797e1c7e1ff7cce81d0dae104cc8"
},
"downloads": -1,
"filename": "sphinxcontrib-programoutput2-2.0a1.tar.gz",
"has_sig": false,
"md5_digest": "6fd1c5ce9996e5be72541620079dfe6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 28422,
"upload_time": "2021-03-11T15:57:30",
"upload_time_iso_8601": "2021-03-11T15:57:30.554897Z",
"url": "https://files.pythonhosted.org/packages/ba/dc/9781d6b6c5d958ab1acb63a218af2d6acc23e92cbef460a03d03ec64dffc/sphinxcontrib-programoutput2-2.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-03-11 15:57:30",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "sphinxcontrib-programoutput2"
}
JSON