Sphinx support for execution of python code from code blocks or files
Sphinx-execute-code is an extension for Sphinx that allows a document author to insert arbitrary python code samples in code blocks, or run python code from python files on the filesystem.
This was written as an alternative to other code execution functions which relied on doctest formats, and attempts to be more flexible, similar to literal-block and code-block statements.
This module allows you to run arbitrary code, and should be treated with caution.
Options right now (as of version 0.2) are:
- If specified, will show line numbers
- If specified, will hide the code block and only show results
- If specified, hides the ‘Code’ and ‘Results’ caption headers around the literal blocks
- If specified, will load code from a file (relative to sphinx doc root) and ignore content.
Running ‘execute_code’ as a directive allows the administrator to embed exact python code as if it was pasted in a normal code-block.
Executing python code and showing the result output:
.. execute_code:: :linenos: print 'python highlight code' class Foo(object): def __init__(self): self.bar = 'baz' def out(self): print self.bar f = Foo() f.out()
You may want to hide the example code that is executing (avoiding highlighting/etc) and display the results only.
We can also hide the code input, showing only the executed code results:
.. execute_code:: :hide_code: print 'This should not print the example code'
Suppressing output headers
Suppressing the ‘Headers’ outputs for Code and Results header:
.. execute_code:: :hide_headers: foo = 32 print 'This will hide the Code and Results text - and foo is %d' % foo
Executing python code from a file
execute_code also allows you to import a python file and execute it within a document.
Running a Python file from filename from the .py example:
.. execute_code:: :filename: tests/example_class.py
This function also supports the argument ‘hide_filename’:
.. execute_code:: :filename: tests/example_class.py :hide_filename:
Installation from source:
$ git clone firstname.lastname@example.org:jpsenior/sphinx-execute-code.git $ python setup.py install
Installation from pypi:
$ pip install sphinx-execute-code
Activating on Sphinx
To activate the extension, add it to your extensions variable in conf.py for your project.
Activating the extension in sphinx:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sphinx_execute_code-0.2a2.tar.gz (6.6 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for sphinx_execute_code-0.2a2.tar.gz