.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "gallery/unRelated.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note Click :ref:`here ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_gallery_unRelated.py: Introductory example - Plotting sin =================================== This is a general example demonstrating a Matplotlib plot output, embedded rST, the use of math notation and cross-linking to other examples. It would be useful to compare the :download:`source Python file ` with the output below. Source files for gallery examples should start with a triple-quoted header docstring. Anything before the docstring is ignored by Sphinx-Gallery and will not appear in the rendered output, nor will it be executed. This docstring requires a rST header, which is used as the title of the example and to correctly build cross-referencing links. Code and embedded rST text blocks follow the docstring. The first block immediately after the docstring is deemed a code block, by default, unless you specify it to be a text block using a line of ``#``'s or ``#%%`` (see below). All code blocks get executed by Sphinx-Gallery and any output, including plots will be captured. Typically, code and text blocks are interspersed to provide narrative explanations of what the code is doing or interpretations of code output. Mathematical expressions can be included as LaTeX, and will be rendered with MathJax. To include displayed math notation, use the directive ``.. math::``. To include inline math notation use the ``:math:`` role. For example, we are about to plot the following function: .. math:: x \rightarrow \sin(x) Here the function :math:`\sin` is evaluated at each point the variable :math:`x` is defined. When including LaTeX in a Python string, ensure that you escape the backslashes or use a :ref:`raw docstring `. You do not need to do this in text blocks (see below). .. GENERATED FROM PYTHON SOURCE LINES 32-48 .. code-block:: default # Code source: Óscar Nájera # License: BSD 3 clause import numpy as np import matplotlib.pyplot as plt x = np.linspace(0, 2 * np.pi, 100) y = np.sin(x) plt.plot(x, y) plt.xlabel(r'$x$') plt.ylabel(r'$\sin(x)$') # To avoid matplotlib text output plt.show() .. GENERATED FROM PYTHON SOURCE LINES 49-53 To include embedded rST, use a line of >= 20 ``#``'s or ``#%%`` between your rST and your code (see :ref:`embedding_rst`). This separates your example into distinct text and code blocks. You can continue writing code below the embedded rST text block: .. GENERATED FROM PYTHON SOURCE LINES 53-56 .. code-block:: default print('This example shows a sin plot!') .. GENERATED FROM PYTHON SOURCE LINES 57-81 LaTeX syntax in the text blocks does not require backslashes to be escaped: .. math:: \sin Cross referencing ^^^^^^^^^^^^^^^^^ You can refer to an example from any part of the documentation, including from other examples. Sphinx-Gallery automatically creates reference labels for each example. The label consists of the ``.py`` file name, prefixed with ``sphx_glr_`` and the name of the folder(s) the example is in. In this case, the example we want to cross-reference is in ``auto_examples`` (the ``gallery_dirs``; see :ref:`configure_and_use_sphinx_gallery`), then the subdirectory ``no_output`` (since the example is within a sub-gallery). The file name of the example is ``plot_syntaxerror.py``. We can thus cross-link to the example 'SyntaxError' using: ``:ref:`sphx_glr_auto_examples_no_output_plot_syntaxerror.py```. .. seealso:: :ref:`sphx_glr_auto_examples_no_output_plot_syntaxerror.py` for a an example with an error. .. |docstring| replace:: """ .. rst-class:: sphx-glr-timing **Total running time of the script:** ( 0 minutes 0.000 seconds) .. _sphx_glr_download_gallery_unRelated.py: .. only :: html .. container:: sphx-glr-footer :class: sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: unRelated.py ` .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: unRelated.ipynb ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_