Commit f434d6af authored by CompPhysChris's avatar CompPhysChris
Browse files

Update docs

parent ab06ad52
%% Cell type:code id: tags:
``` python
%matplotlib inline
```
%% Cell type:markdown id: tags:
An Example on writing examples
==============================
The example docstring will be printed as text along with the code of the example.
It should contain the desciption of the example code.
Only examples that begine with plot_* will be run when generating the docs.
%% Cell type:code id: tags:
``` python
# Code source: Chris Smith
# Liscense: MIT
print('I am an example')
```
"""
An Example on writing examples
==============================
The example docstring will be printed as text along with the code of the example.
It should contain the desciption of the example code.
Only examples that begine with plot_* will be run when generating the docs.
"""
# Code source: Chris Smith
# Liscense: MIT
print('I am an example')
.. _sphx_glr_auto_examples_example_example.py:
An Example on writing examples
==============================
The example docstring will be printed as text along with the code of the example.
It should contain the desciption of the example code.
Only examples that begine with plot_* will be run when generating the docs.
.. code-block:: python
# Code source: Chris Smith
# Liscense: MIT
print('I am an example')
**Total running time of the script:** ( 0 minutes 0.000 seconds)
.. container:: sphx-glr-footer
.. container:: sphx-glr-download
:download:`Download Python source code: example_example.py <example_example.py>`
.. container:: sphx-glr-download
:download:`Download Jupyter notebook: example_example.ipynb <example_example.ipynb>`
.. rst-class:: sphx-glr-signature
`Generated by Sphinx-Gallery <https://sphinx-gallery.readthedocs.io>`_
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment