Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
76 changes: 38 additions & 38 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -55,43 +55,43 @@ per-file-ignores =
lib/pylab.py: F401, F403

doc/conf.py: E402
tutorials/advanced/path_tutorial.py: E402
tutorials/advanced/patheffects_guide.py: E402
tutorials/advanced/transforms_tutorial.py: E402, E501
tutorials/colors/colormaps.py: E501
tutorials/colors/colors.py: E402
tutorials/intermediate/artists.py: E402
tutorials/intermediate/constrainedlayout_guide.py: E402
tutorials/intermediate/legend_guide.py: E402
tutorials/intermediate/tight_layout_guide.py: E402
tutorials/introductory/animation_tutorial.py: E501
tutorials/introductory/images.py: E501
tutorials/introductory/pyplot.py: E402, E501
tutorials/text/annotations.py: E402, E501
tutorials/text/mathtext.py: E501
tutorials/text/text_intro.py: E402
tutorials/text/text_props.py: E501
galleries/tutorials/advanced/path_tutorial.py: E402
galleries/tutorials/advanced/patheffects_guide.py: E402
galleries/tutorials/advanced/transforms_tutorial.py: E402, E501
galleries/tutorials/colors/colormaps.py: E501
galleries/tutorials/colors/colors.py: E402
galleries/tutorials/intermediate/artists.py: E402
galleries/tutorials/intermediate/constrainedlayout_guide.py: E402
galleries/tutorials/intermediate/legend_guide.py: E402
galleries/tutorials/intermediate/tight_layout_guide.py: E402
galleries/tutorials/introductory/animation_tutorial.py: E501
galleries/tutorials/introductory/images.py: E501
galleries/tutorials/introductory/pyplot.py: E402, E501
galleries/tutorials/text/annotations.py: E402, E501
galleries/tutorials/text/mathtext.py: E501
galleries/tutorials/text/text_intro.py: E402
galleries/tutorials/text/text_props.py: E501

examples/animation/frame_grabbing_sgskip.py: E402
examples/images_contours_and_fields/tricontour_demo.py: E201
examples/images_contours_and_fields/tripcolor_demo.py: E201
examples/images_contours_and_fields/triplot_demo.py: E201
examples/lines_bars_and_markers/marker_reference.py: E402
examples/misc/print_stdout_sgskip.py: E402
examples/misc/table_demo.py: E201
examples/style_sheets/bmh.py: E501
examples/subplots_axes_and_figures/demo_constrained_layout.py: E402
examples/text_labels_and_annotations/custom_legends.py: E402
examples/ticks/date_concise_formatter.py: E402
examples/ticks/date_formatters_locators.py: F401
examples/user_interfaces/embedding_in_gtk3_panzoom_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk3_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk4_panzoom_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk4_sgskip.py: E402
examples/user_interfaces/gtk3_spreadsheet_sgskip.py: E402
examples/user_interfaces/gtk4_spreadsheet_sgskip.py: E402
examples/user_interfaces/mpl_with_glade3_sgskip.py: E402
examples/user_interfaces/pylab_with_gtk3_sgskip.py: E402
examples/user_interfaces/pylab_with_gtk4_sgskip.py: E402
examples/userdemo/pgf_preamble_sgskip.py: E402
galleries/examples/animation/frame_grabbing_sgskip.py: E402
galleries/examples/images_contours_and_fields/tricontour_demo.py: E201
galleries/examples/images_contours_and_fields/tripcolor_demo.py: E201
galleries/examples/images_contours_and_fields/triplot_demo.py: E201
galleries/examples/lines_bars_and_markers/marker_reference.py: E402
galleries/examples/misc/print_stdout_sgskip.py: E402
galleries/examples/misc/table_demo.py: E201
galleries/examples/style_sheets/bmh.py: E501
galleries/examples/subplots_axes_and_figures/demo_constrained_layout.py: E402
galleries/examples/text_labels_and_annotations/custom_legends.py: E402
galleries/examples/ticks/date_concise_formatter.py: E402
galleries/examples/ticks/date_formatters_locators.py: F401
galleries/examples/user_interfaces/embedding_in_gtk3_panzoom_sgskip.py: E402
galleries/examples/user_interfaces/embedding_in_gtk3_sgskip.py: E402
galleries/examples/user_interfaces/embedding_in_gtk4_panzoom_sgskip.py: E402
galleries/examples/user_interfaces/embedding_in_gtk4_sgskip.py: E402
galleries/examples/user_interfaces/gtk3_spreadsheet_sgskip.py: E402
galleries/examples/user_interfaces/gtk4_spreadsheet_sgskip.py: E402
galleries/examples/user_interfaces/mpl_with_glade3_sgskip.py: E402
galleries/examples/user_interfaces/pylab_with_gtk3_sgskip.py: E402
galleries/examples/user_interfaces/pylab_with_gtk4_sgskip.py: E402
galleries/examples/userdemo/pgf_preamble_sgskip.py: E402
force-check = True
6 changes: 3 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ on:
paths-ignore:
# Skip running tests if changes are only in documentation directories
- 'doc/**'
- 'examples/**'
- 'plot_types/**'
- 'tutorials/**'
- 'galleries/examples/**'
- 'galleries/plot_types/**'
- 'galleries/tutorials/**'
schedule:
# 5:47 UTC on Saturdays
- cron: "47 5 * * 6"
Expand Down
18 changes: 8 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Thumbs.db

# Things specific to this project #
###################################
tutorials/intermediate/CL01.png
tutorials/intermediate/CL02.png
galleries/tutorials/intermediate/CL01.png
galleries/tutorials/intermediate/CL02.png

# Documentation generated files #
#################################
Expand All @@ -72,14 +72,12 @@ doc/plot_types
doc/pyplots/tex_demo.png
doc/tutorials
lib/dateutil
examples/*/*.bmp
examples/*/*.eps
examples/*/*.pdf
examples/*/*.png
examples/*/*.svg
examples/*/*.svgz
examples/tests/*
!examples/tests/backend_driver_sgskip.py
galleries/examples/*/*.bmp
galleries/examples/*/*.eps
galleries/examples/*/*.pdf
galleries/examples/*/*.png
galleries/examples/*/*.svg
galleries/examples/*/*.svgz
result_images
doc/_static/constrained_layout*.png
doc/.mpl_skip_subdirs.yaml
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ repos:
hooks:
- id: isort
name: isort (python)
files: ^tutorials/|^examples/|^plot_types/
files: ^galleries/tutorials/|^galleries/examples/|^galleries/plot_types/
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
gallery_dirs = [f'{ed}' for ed in ['gallery', 'tutorials', 'plot_types']
if f'{ed}/*' not in skip_subdirs]

example_dirs = [f'../{gd}'.replace('gallery', 'examples') for gd in
gallery_dirs]
example_dirs = [f'../galleries/{gd}'.replace('gallery', 'examples')
for gd in gallery_dirs]

sphinx_gallery_conf = {
'backreferences_dir': Path('api') / Path('_as_gen'),
Expand Down
16 changes: 9 additions & 7 deletions doc/devel/documenting_mpl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 in :file:`plot_types/`, :file:`examples/` and :file:`tutorials/`.
These sources consist of python scripts that have ReST_ documentation built
into their comments. See :ref:`writing-examples-and-tutorials` below.
:file:`doc/tutorials` are generated by the `Sphinx Gallery`_ from python files
Copy link
Member Author

Choose a reason for hiding this comment

The 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
Expand Down Expand Up @@ -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:`/examples/lines_bars_and_markers/simple_plot.py`, which looks like:
:file:`/galleries/examples/lines_bars_and_markers/simple_plot.py`, which looks
like:

.. code-block:: python

Expand Down Expand Up @@ -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 ``# %%`` :
can be the same as the example above. Subsequent blocks of ReST text are
delimited by the line ``# %%`` :

.. code-block:: python

Expand Down
46 changes: 23 additions & 23 deletions doc/sphinxext/gallery_order.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,37 +11,37 @@
UNSORTED = "unsorted"

examples_order = [
'../examples/lines_bars_and_markers',
'../examples/images_contours_and_fields',
'../examples/subplots_axes_and_figures',
'../examples/statistics',
'../examples/pie_and_polar_charts',
'../examples/text_labels_and_annotations',
'../examples/color',
'../examples/shapes_and_collections',
'../examples/style_sheets',
'../examples/pyplots',
'../examples/axes_grid1',
'../examples/axisartist',
'../examples/showcase',
'../galleries/examples/lines_bars_and_markers',
'../galleries/examples/images_contours_and_fields',
'../galleries/examples/subplots_axes_and_figures',
'../galleries/examples/statistics',
'../galleries/examples/pie_and_polar_charts',
'../galleries/examples/text_labels_and_annotations',
'../galleries/examples/color',
'../galleries/examples/shapes_and_collections',
'../galleries/examples/style_sheets',
'../galleries/examples/pyplots',
'../galleries/examples/axes_grid1',
'../galleries/examples/axisartist',
'../galleries/examples/showcase',
UNSORTED,
'../examples/userdemo',
'../galleries/examples/userdemo',
]

tutorials_order = [
'../tutorials/introductory',
'../tutorials/intermediate',
'../tutorials/advanced',
'../galleries/tutorials/introductory',
'../galleries/tutorials/intermediate',
'../galleries/tutorials/advanced',
UNSORTED,
'../tutorials/provisional'
'../galleries/tutorials/provisional'
]

plot_types_order = [
'../plot_types/basic',
'../plot_types/arrays',
'../plot_types/stats',
'../plot_types/unstructured',
'../plot_types/3D',
'../galleries/plot_types/basic',
'../galleries/plot_types/arrays',
'../galleries/plot_types/stats',
'../galleries/plot_types/unstructured',
'../galleries/plot_types/3D',
UNSORTED
]

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading