-
Notifications
You must be signed in to change notification settings - Fork 984
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
switch to uv and pyproject.toml #1776
base: main
Are you sure you want to change the base?
Changes from all commits
32f7656
0c8e268
3171b63
13c5bb4
b63f670
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,25 +57,30 @@ jobs: | |
with: | ||
ref: ${{ env.I18N_BRANCH }} | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
- name: Install uv | ||
uses: astral-sh/setup-uv@v5 | ||
with: | ||
python-version: >- | ||
3.10 | ||
enable-cache: true | ||
cache-dependency-glob: "requirements**.txt" | ||
|
||
- name: Install Python tooling | ||
run: python -m pip install --upgrade nox virtualenv sphinx-lint | ||
run: uv python install | ||
|
||
- name: Install the project | ||
run: uv sync --all-extras --dev | ||
|
||
- name: Set Sphinx problem matcher | ||
uses: sphinx-doc/[email protected] | ||
|
||
- name: Build translated docs in ${{ matrix.language }} | ||
run: nox -s build -- -q -D language=${{ matrix.language }} | ||
run: uv run nox -s build -- -q -D language=${{ matrix.language }} | ||
|
||
- name: Set Sphinx Lint problem matcher | ||
if: always() | ||
run: echo '::add-matcher::.github/sphinx_lint_matcher.json' | ||
|
||
- name: Lint translation file | ||
if: always() | ||
run: sphinx-lint locales/${{ matrix.language }}/LC_MESSAGES/messages.po | ||
run: uv run sphinx-lint locales/${{ matrix.language }}/LC_MESSAGES/messages.po |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
version: 2 | ||
|
||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
|
||
# adapted from uv recipe at https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-uv | ||
# and comment at https://github.com/readthedocs/readthedocs.org/issues/11289#issuecomment-2103832834 | ||
commands: | ||
- asdf plugin add uv | ||
- asdf install uv latest | ||
- asdf global uv latest | ||
- asdf global uv latest | ||
- uv sync --extra docs --frozen | ||
- uv run -m sphinx -T -b html -d source/_build/doctrees source $READTHEDOCS_OUTPUT/html | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sphinx must remain integrated via nox. |
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this empty file added? |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,33 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
[project] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
name = "packaging-python-org" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
version = "0.1.0" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
description = "Overview of Python Packaging" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
readme = "README.rst" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
repository = "https://github.com/pypa/packaging.python.org" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentation = "https://packaging.python.org/en/latest/" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
requires-python = ">=3.9" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
keywords = ["packaging", "518", "621"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
classifiers = [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3.9", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3.10", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3.11", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3.12", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"Programming Language :: Python :: 3.13", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
dependencies = [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"furo==2024.8.6", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx-autobuild==2021.3.14", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx==7.2.6", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx-inline-tabs==2023.4.21", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx-copybutton==0.5.2", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx-toolbox==3.5.0", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment on lines
+1
to
+27
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This project is not a distribution package, it must not have any packaging metadata as it's not supposed to be packaged as such.
Suggested change
Using the dependency groups may be fine, provided that they list docs build environment deps. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
[dependency-groups] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
dev = [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why is this called dev? What's the difference from non-dev? Why is sphinx-lint installed in the same env as nox? Why is virtualenv needed? |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
"nox>=2024.10.9", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"sphinx-lint>=1.0.0", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
"virtualenv>=20.28.1", | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
] |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a deprecated filename that is warned about right at the top of the page, linked in this first line of the file. It must not be used.