Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
MNT: re-organize galleries under one subdir#25209
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Diff view
Diff view
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -21,10 +21,11 @@ the docstrings of the classes in the Matplotlib library. Except for | ||
when the documentation is built. See :ref:`writing-docstrings` below. | ||
Second, the contents of :file:`doc/plot_types`, :file:`doc/gallery` and | ||
:file:`doc/tutorials` are generated by the `Sphinx Gallery`_ from python files | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This file is the only user-facing change. | ||
in :file:`galleries/plot_types/`, :file:`galleries/examples/` and | ||
:file:`galleries/tutorials/`. These sources consist of python scripts that have | ||
ReST_ documentation built into their comments. See | ||
:ref:`writing-examples-and-tutorials` below. | ||
Third, Matplotlib has narrative docs written in ReST_ in subdirectories of | ||
:file:`doc/users/`. If you would like to add new documentation that is suited | ||
@@ -824,7 +825,8 @@ it easy to re-run sub-sections of the example. | ||
For instance the example :doc:`/gallery/lines_bars_and_markers/simple_plot` | ||
example is generated from | ||
:file:`/galleries/examples/lines_bars_and_markers/simple_plot.py`, which looks | ||
like: | ||
.. code-block:: python | ||
@@ -858,8 +860,8 @@ render as comments in :doc:`/gallery/lines_bars_and_markers/simple_plot`. | ||
Tutorials are made with the exact same mechanism, except they are longer, and | ||
typically have more than one comment block (i.e. | ||
:doc:`/tutorials/introductory/quick_start`). The first comment block | ||
can be the same as the example above. Subsequent blocks of ReST text are | ||
delimited by the line ``# %%`` : | ||
.. code-block:: python | ||
Uh oh!
There was an error while loading.Please reload this page.