=============================
sphinxcontrib-programoutput
=============================
.. image:: https://github.com/NextThought/sphinxcontrib-programoutput/workflows/tests/badge.svg
:target: https://github.com/NextThought/sphinxcontrib-programoutput/actions?query=workflow%3Atests
.. image:: https://coveralls.io/repos/github/NextThought/sphinxcontrib-programoutput/badge.svg
:target: https://coveralls.io/github/NextThought/sphinxcontrib-programoutput
https://sphinxcontrib-programoutput.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-programoutput
The extension requires Sphinx 1.7.0 and Python 2.7 or Python 3 (Python
3.6+ is tested) at least.
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 2.7.1
The latter directive mimics a shell session, and is intended to show examples::
.. command-output:: python -V
Output::
$ python -V
Python 2.7.1
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-programoutput
.. _documentation: http://sphinxcontrib-programoutput.readthedocs.org
Raw data
{
"_id": null,
"home_page": "https://sphinxcontrib-programoutput.readthedocs.org/",
"name": "sphinxcontrib-programoutput",
"maintainer": "Jason Madden",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "jason@seecoresoftware.com",
"keywords": "sphinx cli command output program example",
"author": "Sebastian Wiesner",
"author_email": "lunaryorn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3f/c0/834af2290f8477213ec0dd60e90104f5644aa0c37b1a0d6f0a2b5efe03c4/sphinxcontrib_programoutput-0.18.tar.gz",
"platform": "any",
"description": "=============================\n sphinxcontrib-programoutput\n=============================\n\n.. image:: https://github.com/NextThought/sphinxcontrib-programoutput/workflows/tests/badge.svg\n :target: https://github.com/NextThought/sphinxcontrib-programoutput/actions?query=workflow%3Atests\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.6+ 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",
"bugtrack_url": null,
"license": "BSD",
"summary": "Sphinx extension to include program output",
"version": "0.18",
"project_urls": {
"Homepage": "https://sphinxcontrib-programoutput.readthedocs.org/"
},
"split_keywords": [
"sphinx",
"cli",
"command",
"output",
"program",
"example"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "042c7aec6e0580f666d4f61474a50c4995a98abfff27d827f0e7bc8c4fa528f5",
"md5": "e14a36320f51783cddeb3b16953c5e09",
"sha256": "8a651bc85de69a808a064ff0e48d06c12b9347da4fe5fdb1e94914b01e1b0c36"
},
"downloads": -1,
"filename": "sphinxcontrib_programoutput-0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e14a36320f51783cddeb3b16953c5e09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20346,
"upload_time": "2024-12-06T20:38:22",
"upload_time_iso_8601": "2024-12-06T20:38:22.406792Z",
"url": "https://files.pythonhosted.org/packages/04/2c/7aec6e0580f666d4f61474a50c4995a98abfff27d827f0e7bc8c4fa528f5/sphinxcontrib_programoutput-0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fc0834af2290f8477213ec0dd60e90104f5644aa0c37b1a0d6f0a2b5efe03c4",
"md5": "e1b57af28f8265e29003e4e067a4583d",
"sha256": "09e68b6411d937a80b6085f4fdeaa42e0dc5555480385938465f410589d2eed8"
},
"downloads": -1,
"filename": "sphinxcontrib_programoutput-0.18.tar.gz",
"has_sig": false,
"md5_digest": "e1b57af28f8265e29003e4e067a4583d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26333,
"upload_time": "2024-12-06T20:38:36",
"upload_time_iso_8601": "2024-12-06T20:38:36.959289Z",
"url": "https://files.pythonhosted.org/packages/3f/c0/834af2290f8477213ec0dd60e90104f5644aa0c37b1a0d6f0a2b5efe03c4/sphinxcontrib_programoutput-0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 20:38:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinxcontrib-programoutput"
}
JSON