8000 refactor: migrate to `pyproject.toml` by Borda · Pull Request #1267 · sphinx-gallery/sphinx-gallery · GitHub
[go: up one dir, main page]
Skip to content

refactor: migrate to pyproject.toml #1267

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 15 commits into from
Mar 19, 2024
Merged

refactor: migrate to pyproject.toml #1267

merged 15 commits into from
Mar 19, 2024

Conversation

Borda
Copy link
Contributor
@Borda Borda commented Mar 10, 2024

Closes #1142

Borda
Borda commented Mar 10, 2024
View reviewed changes
This was referenced Mar 10, 2024
Merged
Merged
@Borda Borda marked this pull request as ready for review March 11, 2024 18:09
@Borda
Copy link
Contributor Author
Borda commented Mar 11, 2024

@larsoner mind have a look 🐿️

larsoner
larsoner reviewed Mar 11, 2024
View reviewed changes
Copy link
Contributor
@larsoner larsoner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable in principle aside from some potential differences I suspect are there. Those differences make me think that it would be safest to do a directory diff between the unzipped sdist and/or .whl on master and this PR to make sure we aren't adding or removing things we shouldn't.

Borda
Borda commented Mar 11, 2024
View reviewed changes
larsoner
larsoner reviewed Mar 12, 2024
View reviewed changes
@larsoner
Copy link
Contributor

Can you try the directory diff and let me know how it looks?

@Borda
Copy link
Contributor Author
Borda commented Mar 14, 2024 •
edited
Loading

Can you try the directory diff and let me know how it looks?

not sure what you mean, like building a package from master and, with this suggestion to see if there is a difference in the package? 🐿️

@larsoner
Copy link
Contributor

Yes for the sdist and for the .whl

@Borda
Copy link
Contributor Author
Borda commented Mar 19, 2024 •
edited
Loading

this is the version from master:

dist/master/
└── sphinx-gallery-0.16.dev0
    ├── CHANGES.rst
    ├── examples
    │   ├── local_module.py
    │   ├── no_output
    │   │   ├── just_code.py
    │   │   ├── plot_raise.py
    │   │   ├── plot_strings.py
    │   │   ├── plot_syntaxerror.py
    │   │   └── README.txt
    │   ├── plot_0_sin.py
    │   ├── plot_1_exp.py
    │   ├── plot_2_seaborn.py
    │   ├── plot_3_capture_repr.py
    │   ├── plot_4b_provide_thumbnail.py
    │   ├── plot_4_choose_thumbnail.py
    │   ├── plot_5_unicode_everywhere.py
    │   ├── plot_6_function_identifier.py
    │   ├── plot_7_sys_argv.py
    │   ├── plot_8_animations.py
    │   └── README.txt
    ├── ignore_words.txt
    ├── LICENSE
    ├── MANIFEST.in
    ├── PKG-INFO
    ├── plotly_examples
    │   ├── plot_0_plotly.py
    │   └── README.rst
    ├── pyproject.toml
    ├── pyvista_examples
    │   ├── plot_collisions.py
    │   ├── plot_glyphs.py
    │   ├── plot_lighting.py
    │   ├── plot_ray_trace.py
    │   └── README.rst
    ├── README.rst
    ├── requirements.txt
    ├── setup.cfg
    ├── setup.py
    ├── sphinx_gallery
    │   ├── backreferences.py
    │   ├── block_parser.py
    │   ├── directives.py
    │   ├── docs_resolv.py
    │   ├── downloads.py
    │   ├── gen_gallery.py
    │   ├── gen_rst.py
    │   ├── __init__.py
    │   ├── interactive_example.py
    │   ├── load_style.py
    │   ├── notebook.py
    │   ├── py_source_parser.py
    │   ├── recommender.py
    │   ├── scrapers.py
    │   ├── sorting.py
    │   ├── _static
    │   │   ├── binder_badge_logo.svg
    │   │   ├── broken_example.png
    │   │   ├── jupyterlite_badge_logo.svg
    │   │   ├── no_image.png
    │   │   ├── sg_gallery-binder.css
    │   │   ├── sg_gallery.css
    │   │   ├── sg_gallery-dataframe.css
    │   │   └── sg_gallery-rendered-html.css
    │   ├── tests
    │   │   ├── conftest.py
    │   │   ├── __init__.py
    │   │   ├── reference_parse.txt
    │   │   ├── test_backreferences.py
    │   │   ├── test_block_parser.py
    │   │   ├── testconfs
    │   │   │   ├── index.rst
    │   │   │   └── src
    │   │   │       ├── plot_1.py
    │   │   │       ├── plot_2.py
    │   │   │       ├── plot_3.py
    │   │   │       └── README.txt
    │   │   ├── test_docs_resolv.py
    │   │   ├── test_full_noexec.py
    │   │   ├── test_full.py
    │   │   ├── test_gen_gallery.py
    │   │   ├── test_gen_rst.py
    │   │   ├── test_interactive_example.py
    │   │   ├── test_load_style.py
    │   │   ├── test_notebook.py
    │   │   ├── test_py_source_parser.py
    │   │   ├── test_recommender.py
    │   │   ├── test_scrapers.py
    │   │   ├── test_sorting.py
    │   │   └── tinybuild
    │   │       ├── doc
    │   │       │   ├── binder
    │   │       │   │   └── requirements.txt
    │   │       │   ├── conf.py
    │   │       │   ├── index.rst
    │   │       │   ├── make.bat
    │   │       │   ├── Makefile
    │   │       │   ├── minigallery.rst
    │   │       │   ├── _static_nonstandard
    │   │       │   │   └── demo.png
    │   │       │   └── _templates
    │   │       │       └── module.rst
    │   │       ├── examples
    │   │       │   ├── future
    │   │       │   │   ├── plot_future_imports_broken.py
    │   │       │   │   ├── plot_future_imports.py
    │   │       │   │   └── README.rst
    │   │       │   ├── __init__.py
    │   │       │   ├── isentropic.m
    │   │       │   ├── julia_sample.jl
    │   │       │   ├── local_module.py
    │   │       │   ├── parse_this.cpp
    │   │       │   ├── plot_animation.py
    │   │       │   ├── plot_command_line_args.py
    │   │       │   ├── plot_defer_figures.py
    │   │       │   ├── plot_log.py
    │   │       │   ├── plot_matplotlib_alt.py
    │   │       │   ├── plot_matplotlib_backend.py
    │   │       │   ├── plot_numpy_matplotlib.py
    │   │       │   ├── plot_pickle.py
    │   │       │   ├── plot_repr.py
    │   │       │   ├── plot_scraper_broken.py
    │   │       │   ├── plot_second_future_imports.py
    │   │       │   ├── plot_svg.py
    │   │       │   ├── plot_webp.py
    │   │       │   └── README.txt
    │   │       ├── examples_rst_index
    │   │       │   ├── examp_subdir1
    │   │       │   │   ├── plot_sub1.py
    │   │       │   │   └── README.txt
    │   │       │   ├── examp_subdir2
    │   │       │   │   ├── index.rst
    │   │       │   │   └── plot_sub2.py
    │   │       │   ├── index.rst
    │   │       │   └── plot_examp.py
    │   │       └── examples_with_rst
    │   │           ├── plot_boo.py
    │   │           ├── plot_cos.py
    │   │           ├── README.txt
    │   │           ├── rst_example1.rst
    │   │           └── rst_example2.rst
    │   └── utils.py
    ├── sphinx_gallery.egg-info
    │   ├── dependency_links.txt
    │   ├── entry_points.txt
    │   ├── PKG-INFO
    │   ├── requires.txt
    │   ├── SOURCES.txt
    │   └── top_level.txt
    └── tutorials
        ├── plot_parse.py
        └── README.txt

and this is with this PR:

dist/pr-pyproject/
└── sphinx-gallery-0.16.dev0
    ├── CHANGES.rst
    ├── examples
    │   ├── local_module.py
    │   ├── no_output
    │   │   ├── just_code.py
    │   │   ├── plot_raise.py
    │   │   ├── plot_strings.py
    │   │   ├── plot_syntaxerror.py
    │   │   └── README.txt
    │   ├── plot_0_sin.py
    │   ├── plot_1_exp.py
    │   ├── plot_2_seaborn.py
    │   ├── plot_3_capture_repr.py
    │   ├── plot_4b_provide_thumbnail.py
    │   ├── plot_4_choose_thumbnail.py
    │   ├── plot_5_unicode_everywhere.py
    │   ├── plot_6_function_identifier.py
    │   ├── plot_7_sys_argv.py
    │   ├── plot_8_animations.py
    │   └── README.txt
    ├── ignore_words.txt
    ├── LICENSE
    ├── MANIFEST.in
    ├── PKG-INFO
    ├── plotly_examples
    │   ├── plot_0_plotly.py
    │   └── README.rst
    ├── pyproject.toml
    ├── pyvista_examples
    │   ├── plot_collisions.py
    │   ├── plot_glyphs.py
    │   ├── plot_lighting.py
    │   ├── plot_ray_trace.py
    │   └── README.rst
    ├── README.rst
    ├── setup.cfg
    ├── sphinx_gallery
    │   ├── backreferences.py
    │   ├── block_parser.py
    │   ├── directives.py
    │   ├── docs_resolv.py
    │   ├── downloads.py
    │   ├── gen_gallery.py
    │   ├── gen_rst.py
    │   ├── __init__.py
    │   ├── interactive_example.py
    │   ├── load_style.py
    │   ├── notebook.py
    │   ├── py_source_parser.py
    │   ├── recommender.py
    │   ├── scrapers.py
    │   ├── sorting.py
    │   ├── _static
    │   │   ├── binder_badge_logo.svg
    │   │   ├── broken_example.png
    │   │   ├── jupyterlite_badge_logo.svg
    │   │   ├── no_image.png
    │   │   ├── sg_gallery-binder.css
    │   │   ├── sg_gallery.css
    │   │   ├── sg_gallery-dataframe.css
    │   │   └── sg_gallery-rendered-html.css
    │   ├── tests
    │   │   ├── conftest.py
    │   │   ├── __init__.py
    │   │   ├── reference_parse.txt
    │   │   ├── test_backreferences.py
    │   │   ├── test_block_parser.py
    │   │   ├── testconfs
    │   │   │   ├── index.rst
    │   │   │   └── src
    │   │   │       ├── plot_1.py
    │   │   │       ├── plot_2.py
    │   │   │       ├── plot_3.py
    │   │   │       └── README.txt
    │   │   ├── test_docs_resolv.py
    │   │   ├── test_full_noexec.py
    │   │   ├── test_full.py
    │   │   ├── test_gen_gallery.py
    │   │   ├── test_gen_rst.py
    │   │   ├── test_interactive_example.py
    │   │   ├── test_load_style.py
    │   │   ├── test_notebook.py
    │   │   ├── test_py_source_parser.py
    │   │   ├── test_recommender.py
    │   │   ├── test_scrapers.py
    │   │   ├── test_sorting.py
    │   │   └── tinybuild
    │   │       ├── doc
    │   │       │   ├── binder
    │   │       │   │   └── requirements.txt
    │   │       │   ├── conf.py
    │   │       │   ├── index.rst
    │   │       │   ├── make.bat
    │   │       │   ├── Makefile
    │   │       │   ├── minigallery.rst
    │   │       │   ├── _static_nonstandard
    │   │       │   │   └── demo.png
    │   │       │   └── _templates
    │   │       │       └── module.rst
    │   │       ├── examples
    │   │       │   ├── future
    │   │       │   │   ├── plot_future_imports_broken.py
    │   │       │   │   ├── plot_future_imports.py
    │   │       │   │   └── README.rst
    │   │       │   ├── __init__.py
    │   │       │   ├── isentropic.m
    │   │       │   ├── julia_sample.jl
    │   │       │   ├── local_module.py
    │   │       │   ├── parse_this.cpp
    │   │       │   ├── plot_animation.py
    │   │       │   ├── plot_command_line_args.py
    │   │       │   ├── plot_defer_figures.py
    │   │       │   ├── plot_log.py
    │   │       │   ├── plot_matplotlib_alt.py
    │   │       │   ├── plot_matplotlib_backend.py
    │   │       │   ├── plot_numpy_matplotlib.py
    │   │       │   ├── plot_pickle.py
    │   │       │   ├── plot_repr.py
    │   │       │   ├── plot_scraper_broken.py
    │   │       │   ├── plot_second_future_imports.py
    │   │       │   ├── plot_svg.py
    │   │       │   ├── plot_webp.py
    │   │       │   └── README.txt
    │   │       ├── examples_rst_index
    │   │       │   ├── examp_subdir1
    │   │       │   │   ├── plot_sub1.py
    │   │       │   │   └── README.txt
    │   │       │   ├── examp_subdir2
    │   │       │   │   ├── index.rst
    │   │       │   │   └── plot_sub2.py
    │   │       │   ├── index.rst
    │   │       │   └── plot_examp.py
    │   │       └── examples_with_rst
    │   │           ├── plot_boo.py
    │   │           ├── plot_cos.py
    │   │           ├── README.txt
    │   │           ├── rst_example1.rst
    │   │           └── rst_example2.rst
    │   └── utils.py
    ├── sphinx_gallery.egg-info
    │   ├── dependency_links.txt
    │   ├── entry_points.txt
    │   ├── PKG-INFO
    │   ├── requires.txt
    │   ├── SOURCES.txt
    │   └── top_level.txt
    └── tutorials
        ├── plot_parse.py
        └── README.txt

the only diff is as expected missing:

    ├── requirements.txt
    ...
    ├── setup.py

@Borda Borda requested review from larsoner and lucyleeow March 19, 2024 18:32
@larsoner larsoner merged commit 92ed86e into sphinx-gallery:master Mar 19, 2024
@larsoner
Copy link
Contributor

Thanks @Borda !

@Borda Borda deleted the refactor/pyproject branch March 19, 2024 19:02
@lucyleeow
Copy link
Contributor

Thank you @Borda 🙏 !

@AlexSzatmary AlexSzatmary mentioned this pull request Jun 2, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@larsoner larsoner Awaiting requested review from larsoner

@lucyleeow lucyleeow Awaiting requested review from lucyleeow

Assignees
No one assigned
Labels
maintenance
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Borda @larsoner @lucyleeow
0