Metadata-Version: 1.1
Name: sphinxcontrib-pyexec
Version: 0.0.2
Summary: sphinxcontrib-pyexec
Home-page: https://github.com/3ptscience/sphinxcontrib-pyexec
Author: Lindsey Heagy
Author-email: lindsey@3ptscience.com
License: MIT
Download-URL: https://github.com/3ptscience/sphinxcontrib-pyexec
Description: # PyExec
        
        A sphinx extension for running python code and displaying both the input and
        output [sphinx documentation](http://www.sphinx-doc.org/). 
        
        In the conf.py add `PyExec` to your extensions.
        
        In the ReStructuredText file, use the `exec` environment
        
        ```
          .. exec::
            print 2 + 2
        ```
        
        To output python code & the results in your documentation. 
        
        ```
          >> print 2 + 2
          4
        ```
        
        Note that you need to include the `print` statement for the output to be shown. To see it in action, checkout the [Properties documentation](http://propertiespy.readthedocs.io/). 
        
        Based on
        
        - https://github.com/sphinx-doc/sphinx/blob/master/sphinx/directives/code.py
        - http://stackoverflow.com/a/18143318/6086999
        
        
        
        
Keywords: sphinx documentation python execute
Platform: Windows
Platform: Linux
Platform: Solaris
Platform: Mac OS-X
Platform: Unix
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Natural Language :: English
