magics.rst
23 lines
| 939 B
| text/x-rst
|
RstLexer
Thomas Kluyver
|
r18294 | ======================= | ||
Built-in magic commands | ||||
======================= | ||||
Matthias Bussonnier
|
r22598 | .. note:: | ||
Carol Willing
|
r22601 | To Jupyter users: Magics are specific to and provided by the IPython kernel. | ||
hongshaoyang
|
r24592 | Whether Magics are available on a kernel is a decision that is made by | ||
Carol Willing
|
r22601 | the kernel developer on a per-kernel basis. To work properly, Magics must | ||
use a syntax element which is not valid in the underlying language. For | ||||
hongshaoyang
|
r24592 | example, the IPython kernel uses the `%` syntax element for Magics as `%` | ||
is not a valid unary operator in Python. However, `%` might have meaning in | ||||
other languages. | ||||
Matthias Bussonnier
|
r22598 | |||
hongshaoyang
|
r24592 | Here is the help auto-generated from the docstrings of all the available Magics | ||
Danny Hermes
|
r25387 | functions that IPython ships with. | ||
Matthias Bussonnier
|
r22598 | |||
Danny Hermes
|
r25387 | You can create and register your own Magics with IPython. You can find many user | ||
hongshaoyang
|
r24592 | defined Magics on `PyPI <https://pypi.io>`_. Feel free to publish your own and | ||
Matthias Bussonnier
|
r22598 | use the ``Framework :: IPython`` trove classifier. | ||
Thomas Kluyver
|
r18294 | .. include:: magics-generated.txt | ||