sphinx-exec-code

A Sphinx extension to run python code in the documentation

About

Sphinx-exec-code allows execution of any python code during the documentation build. It's also possible to display the output of the code execution.

With this extension it's easy to ensure that the provided code samples are always working. Additionally, it's possible to show the output of the documented code.

Each code snippet runs in a fresh interpreter so changes to not leak between executions.

Documentation

The full documentation can be found at here

Quick Example

.. exec-code::

   print('This code will be executed')

generates

print('This code will be executed')

This code will be executed

Changelog

0.12 (2024-01-09)

• Error when providing invalid options

0.11 (2024-01-09)

• Updated CI and ruff fixes

0.10 (2023-02-13)

• Fixed a bug when no code was shown/executed

0.9 (2023-02-08)

• If the whole shown code block is indented the indention is removed

0.8 (2022-07-18)

• Renamed exec_code_folders to exec_code_source_folders
• Changed type of parameter to specify stdout to a flag
• Changed default for config parameter that sets encoding
• Dropped support for Python 3.7

0.7 (2022-07-15)

• Added config parameter to specify stdout encoding
• Only empty lines of the output get trimmed

0.6 (2022-04-04)

• Fixed an issue where the line numbers for error messages were not correct

0.5 (2022-03-10)

• Marked as safe for parallel reading

0.4 (2022-03-09)

• Added option to run code from example files

0.3 (2021-09-24)

• Added some more documentation and fixed some false path warnings

0.2 (2021-09-21)

• Initial Release