Include dev dependencies in pyproject.toml and update docs on requirements#1317
Conversation
…ments Note that `namespaces = true` is now set in pyproject.toml, which resolves "Package would be ignored" warnings
for more information, see https://pre-commit.ci
larsoner
left a comment
There was a problem hiding this comment.
Just tweaked a comment to reflect the new behavior, making for merge when green, thanks @AlexSzatmary
|
Oh CIs are unhappy, looks like there are still some references to dev-requirements. Maybe |
|
@larsoner Thanks for the speedy review! I see that CI needed dev-requirements.txt . I will look into telling CI to install using the dev option. |
|
Okay let me know whenever you need me to approve CIs. GH is going to ask on every commit you push as a new contributor 😬 |
|
I looked at.github/install.sh . There are a lot of possible combinations of installed dependencies. Do they still work as intended since the migration to pyproject.toml? It seems pip would install dependencies even for cases where that is not intended, such as minimal. It would be nice if there were at least comments explaining all of the variants. |
|
Yeah it is not super well documented. Want me to try pushing a commit? In short I would try changing any instance of |
|
@larsoner feel free to try that. Alternatively, I think that, is the most one-for-one comparable to the You would know better than I would which is the better approach. |
|
I'm also not sure if it's better to include --no-build-isolation in |
|
Thanks @AlexSzatmary ! I went with the minimalist approach in 4178d84 of just replacing the |
|
Awesome, thanks @larsoner ! |
sphinx-gallery migrated to pyproject.toml (see #1267) but this migration was not fully implemented. In particular,
requirements.txtwas removed but it is still referenced in several files. The developer install instructions were not updated (#1316) but this PR should resolve that issue. Also, the quickstart in README.rst says, "Sphinx-Gallery will not manage its dependencies" but with dependencies listed in pyproject.toml, pip now takes care of that.I moved the contents of dev-requirements.txt into pyproject.toml and updated docs on how to install for contributors.
I also noticed a lot of "Package would be ignored" warnings. I resolved that by setting
namespaces = truein pyproject.toml, which resolves that warning and is the default. I diffed the trees for the installed sphinx-gallery with and without that change; there was no difference.