Execute code blocks in Sphinx and display the output
Project description
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 inspect and print output of the documented code.
Documentation
The full documentation can be found at here
Quick Example
.. exec-code::
:hide_output:
print('This code will be executed')
Changelog
0.2 (21.09.2021)
- Initial Release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-exec-code-0.2.tar.gz
(10.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_exec_code-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1222b306cfd8fbd263451f38acf5de806e11306929a86549d29fe6eb557b1b88 |
|
MD5 | d6b8ee2690cfd962ed1315bd566adade |
|
BLAKE2b-256 | c46145b88db43d75d67de03c0846da397689d92f62cf3c1693353f8b6bff9e67 |