Skip to content

Add tox lint target #11602

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 3 commits into from
Jul 6, 2024
Merged

Conversation

stephenfin
Copy link
Contributor

@stephenfin stephenfin commented Aug 16, 2023

Feature or Bugfix

Refactoring

Purpose

Re-add a tox environment for linters. This environment uses the 'lint' extras
and runs the same commands as the GitHub Workflows. A note is added reminding
people to keep the two in-sync.

Detail

This resolves #11599. There is an (arguably superior but more involved) alternative at #11603.

Relates

(none)

@stephenfin
Copy link
Contributor Author

#11603 is a superior option that minimises duplication all around. Let's go with that approach.

@electric-coder
Copy link

@picnixz

Oh good to know. @AA-Turner any reason why we are not applying mypy to tests actually?

Most likely because it can be a lot of extra work and maintainers didn't prioritize it. However, it would improve code quality.

@stephenfin

Not @AA-Turner but that's usually why I don't run mypy over tests, yes.

Absolutely worth it even if you have to use # ignore on occasion.

'isolated_build' is no longer required since builds are isolated by
default in tox 4.

'basepython' is no longer required since tox 4 only supports Python 3
and 'basepython' defaults to the version of Python that tox is installed
with.

Signed-off-by: Stephen Finucane <[email protected]>
This simply runs the same commands as the GitHub CI workflows.

Signed-off-by: Stephen Finucane <[email protected]>
@stephenfin stephenfin force-pushed the readd-tox-integration branch from 4b12fb8 to 7da84e9 Compare July 4, 2024 16:58
@AA-Turner AA-Turner changed the title Re-add tox integration Add tox lint target Jul 6, 2024
@AA-Turner AA-Turner merged commit 5ea16e7 into sphinx-doc:master Jul 6, 2024
7 checks passed
@stephenfin stephenfin deleted the readd-tox-integration branch July 8, 2024 08:36
@AA-Turner AA-Turner added this to the 7.4.0 milestone Jul 13, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tox targets for non-tests
4 participants