sphinx-exec-directive

sphinx-exec-directive is a Sphinx extension which allows you to write code blocks in reStructuredText files, execute them during Sphinx compilation, and display the output directly within the generated documentation.

The default code language is Python, but there is some limited support for other languages right now. Note that, for other languages, you will generally need to have the relevant executables in $PATH.

This is based very strongly on matplotlib’s plot_directive extension, but is used for running code instead of generating plots.

Contents

• Installation
• Basic usage: Python
  • Reading code from a file
• Options
  • Caching
  • Context preservation
  • Interspersed text
• Other languages

• Index

• Search Page