A how-to that is nothing more than a jupyter notebookΒΆ
Using jupyter notebooks inside docs is very simple: it only requires nbsphinx and pandoc.
This way, you can add any tutorials and how-tos to your code while ensuring all the commands you are using are working properly.
[1]:
from pyretem.module1 import compute_something
a = 1
b = 2
compute_something(a, b)
[1]:
3
Have you also noticed the nice copy button? (sphinx-copybutton, nothing else).