-
Notifications
You must be signed in to change notification settings - Fork 29
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
Improvements & general refactoring #133
Open
AA-Turner
wants to merge
19
commits into
wpilibsuite:main
Choose a base branch
from
AA-Turner:refactor
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Move to pyproject.toml metadata - Use pypa/build - Update workflows and tooling
eff1e85
to
8b0e920
Compare
3597d31
to
8c7a7cf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To allow python/cpython#129120, we need to introduce the ability to have a different URL base for social card images to the canonical URL.
In preparation to start this work I have made some general improvements to the codebase, which are described in each commit. I would suggest rebase-merging or fast-forward merging to maintain understandable history.
Closes #44. Move from the deprecated
setup.py
to the standardisedpyproject.toml
, maintaining git history bygit mv
ing the file first. We also fix a markup error inLICENCE.md
, as it is declared to be a markdown file.Closes #129. Read the Docs no longer inject
html_baseurl
.Closes #131. Python 3.13 was released in October last year.
We don't need to call the method twice, we can just return both strings and use tuple unpacking.
CLoses #112. This makes the feature more discoverable.
Closes #111.
sphinx.testing.path
is deprecated.Linting.
We use a membership test with
in
, so we should use a set rather than a list.Reduces the support matrix. Python 3.8 is end-of-life. I would also suggest dropping Python 3.9, but that is more arguable. Sphinx 5 was released three years ago.
Ruff is a fast linter and formatter that has wide adoption, including in Sphinx and CPython.
Type annotations are useful in IDEs such as PyCharm, and for downstream projects.
Miscellaneous refactoring to make functions smaller and arguments more explicit.
Enable more categories beyond general correctness, including requiring that every function is annotated and ensuring imports aren't redundantly aliased (fixing e.g.
import docutils.nodes as nodes
).cc @ItayZiv @TheTripleV @Daltz333 @sciencewhiz
A