##// END OF EJS Templates
Add linebreak to docstring to fix markup and silence Sphinx waraning....
Add linebreak to docstring to fix markup and silence Sphinx waraning. Without the added linebreak the line of ----- is treated as heading markup for the line below, and it is broken markup because it is an overline without an underline. With the added linebreak the line of ------ is rendered as an hr element and the line below is also rendered.

File last commit:

r22963:2961b531
r24065:6667a88e
Show More
example-demo.py
42 lines | 1.2 KiB | text/x-python | PythonLexer
# -*- coding: utf-8 -*-
"""A simple interactive demo to illustrate the use of IPython's Demo class.
Any python script can be run as a demo, but that does little more than showing
it on-screen, syntax-highlighted in one shot. If you add a little simple
markup, you can stop at specified intervals and return to the ipython prompt,
resuming execution later.
This is a unicode test, åäö
"""
print('Hello, welcome to an interactive IPython demo.')
print('Executing this block should require confirmation before proceeding,')
print('unless auto_all has been set to true in the demo object')
# The mark below defines a block boundary, which is a point where IPython will
# stop execution and return to the interactive prompt.
# <demo> --- stop ---
x = 1
y = 2
# <demo> --- stop ---
# the mark below makes this block as silent
# <demo> silent
print('This is a silent block, which gets executed but not printed.')
# <demo> --- stop ---
# <demo> auto
print('This is an automatic block.')
print('It is executed without asking for confirmation, but printed.')
z = x+y
print('z=',x)
# <demo> --- stop ---
# This is just another normal block.
print('z is now:', z)
print('bye!')