We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 0661045 commit 50e6878Copy full SHA for 50e6878
doc/source/index.rst
@@ -147,7 +147,16 @@ produces:
147
148
print('this code is invisible')
149
150
-or vice versa with ``:hide-output:``::
+this option is particularly useful if you want to embed correctness checks in building your documentation::
151
+
152
+ .. jupyter-execute::
153
+ :hide-code:
154
155
+ assert everything_works, "There's a bug somewhere"
156
157
+This way even though the code won't make it into the documentation, the build will fail if running the code fails.
158
159
+Similarly, outputs are hidden with ``:hide-output:``::
160
161
.. jupyter-execute::
162
:hide-output:
0 commit comments