Metadata-Version: 2.4
Name: sphinxcontrib-programoutput2
Version: 0.0.0
Summary: Sphinx extension to include program output
Home-page: https://sphinxcontrib-programoutput2.readthedocs.org/
Author: Sebastian Wiesner
Author-email: lunaryorn@gmail.com
Maintainer: Sorin Sbarnea
Maintainer-email: sorin.sbarnea@gmail.com
License: BSD
Project-URL: Bug Tracker, https://github.com/sphinx-contrib/sphinxcontrib-programoutput/issues
Project-URL: CI: GitHub, https://github.com/sphinx-contrib/sphinxcontrib-programoutput/actions?query=workflow:gh+branch:master+event:push
Project-URL: Documentation, https://sphinxcontrib-programoutput2.readthedocs.org/
Project-URL: Source Code, https://github.com/sphinx-contrib/sphinxcontrib-programoutput
Keywords: sphinx,cli,command,output,program,example
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Provides: sphinxcontrib.programoutput
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Sphinx>=1.7.0
Provides-Extra: test
Requires-Dist: coverage>=5.3.1; extra == "test"
Requires-Dist: mock; extra == "test"
Requires-Dist: pytest; extra == "test"
Dynamic: license-file
Dynamic: provides

============================
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
