Skip to content

Commit

Permalink
Merge branch 'master' into autosummary-short-signature
Browse files Browse the repository at this point in the history
  • Loading branch information
timhoffm authored Jan 7, 2025
2 parents df273d6 + 74ec220 commit 712e7ed
Show file tree
Hide file tree
Showing 340 changed files with 12,093 additions and 8,079 deletions.
38 changes: 0 additions & 38 deletions .flake8

This file was deleted.

65 changes: 65 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Binary data types
*.gif binary
*.jpg binary
*.mo binary
*.pdf binary
*.png binary
*.zip binary

# Unix-style line endings
[attr]unix text eol=lf

*.conf unix
*.css unix
*.cls unix
*.csv unix
*.dot unix
*.html unix
*.inc unix
*.ini unix
*.jinja unix
*.js unix
*.md unix
*.mjs unix
*.py unix
*.rst unix
*.sty unix
*.tex unix
*.toml unix
*.txt unix
*.svg unix
*.xml unix
*.yml unix

# CRLF files
[attr]dos text eol=crlf

*.bat dos
*.bat.jinja dos
*.stp dos
tests/roots/test-pycode/cp_1251_coded.py dos

# Language aware diff headers
*.c diff=cpp
*.h diff=cpp
*.css diff=css
*.html diff=html
*.md diff=markdown
*.py diff=python
# *.rst diff=reStructuredText
*.tex diff=tex

# Non UTF-8 encodings
tests/roots/test-pycode/cp_1251_coded.py working-tree-encoding=windows-1251

# Generated files
# https://github.com/github/linguist/blob/master/docs/overrides.md
#
# To always hide generated files in local diffs, mark them as binary:
# $ git config diff.generated.binary true
#
[attr]generated linguist-generated=true diff=generated

tests/js/fixtures/**/*.js generated
sphinx/search/minified-js/*.js generated
sphinx/themes/bizstyle/static/css3-mediaqueries.js generated
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ contact_links:
url: https://stackoverflow.com/questions/tagged/python-sphinx
about: For Q&A purpose, please use Stackoverflow with the tag python-sphinx
- name: Discussion
url: https://groups.google.com/forum/#!forum/sphinx-users
about: For general discussion, please use sphinx-users mailing list.
url: https://github.com/sphinx-doc/sphinx/discussions
about: For general discussion, please use GitHub Discussions.
42 changes: 28 additions & 14 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
Subject: <short purpose of this pull request>
<!--
Thank you for creating this pull request and for spending time to help Sphinx!
Our contributors' guide can be found online: https://www.sphinx-doc.org/en/master/internals/contributing.html
Ask any questions at https://github.com/sphinx-doc/sphinx/discussions
-->

### Feature or Bugfix
<!-- please choose -->
- Feature
- Bugfix
- Refactoring

### Purpose
- <long purpose of this pull request>
- <Environment if this PR depends on>
## Purpose

### Detail
- <feature1 or bug1>
- <feature2 or bug2>
<!--
A description of the purpose of this pull request.
Ensure that all relevant information is included for reviewers,
including any environment-specific details.
### Relates
- <URL or Ticket>
* If you plan to add tests or documentation after opening this PR,
please note it here.
* For user-visible changes, remember to add an entry to CHANGES.rst.
* Please add your name to AUTHORS.rst if you haven't already!
-->


## References

<!--
Please add any relevant links here, especially including any
GitHub issues or Pull Requests that this PR would resolve.
This helps to ensure that reviewers have context from
previous discussions or decisions.
-->

- <...>
- <...>
- <...>
9 changes: 4 additions & 5 deletions .github/workflows/builddoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ jobs:
- name: Install graphviz
run: sudo apt-get install --no-install-recommends --yes graphviz
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install .[docs]
- name: Render the documentation
Expand Down
13 changes: 5 additions & 8 deletions .github/workflows/create-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,14 @@ jobs:
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false

- name: Install build dependencies (pypa/build, twine)
run: |
uv pip install build "twine>=5.1"
# resolution fails without betterproto and protobuf-specs
uv pip install "pypi-attestations~=0.0.12" "sigstore-protobuf-specs==0.3.2" "betterproto==2.0.0b6"
- name: Build distribution
run: python -m build
Expand All @@ -65,7 +62,7 @@ jobs:

- name: Convert attestations to PEP 740
run: >
python utils/convert_attestations.py
uv run utils/convert_attestations.py
"$BUNDLE_PATH"
"$SIGNER_IDENTITY"
env:
Expand Down
74 changes: 23 additions & 51 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,41 +31,17 @@ jobs:
RUFF_VERSION=$(awk -F'[="]' '/\[project\.optional-dependencies\]/ {p=1} /ruff/ {if (p) print $4}' pyproject.toml)
echo "RUFF_VERSION=$RUFF_VERSION" >> $GITHUB_ENV
- name: Install Ruff
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
--write-out "%{stderr}Downloaded: %{url}\n"
"https://astral.sh/ruff/$RUFF_VERSION/install.sh"
| sh
- name: Install Ruff ${{ env.RUFF_VERSION }}
uses: astral-sh/ruff-action@v3
with:
args: --version
version: ${{ env.RUFF_VERSION }}

- name: Lint with Ruff
run: ruff check . --output-format github
run: ruff check --output-format=github

- name: Format with Ruff
run: ruff format . --diff

flake8:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
- name: Install dependencies
run: uv pip install --upgrade "flake8>=6.0"
- name: Lint with flake8
run: flake8 .
run: ruff format --diff

mypy:
runs-on: ubuntu-latest
Expand All @@ -79,11 +55,10 @@ jobs:
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install ".[lint,test]"
- name: Type check with mypy
Expand All @@ -101,11 +76,10 @@ jobs:
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install ".[lint,test]"
- name: Type check with pyright
Expand All @@ -123,11 +97,10 @@ jobs:
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install --upgrade sphinx-lint
- name: Lint documentation with sphinx-lint
Expand All @@ -145,11 +118,10 @@ jobs:
with:
python-version: "3"
- name: Install uv
run: >
curl --no-progress-meter --location --fail
--proto '=https' --tlsv1.2
"https://astral.sh/uv/install.sh"
| sh
uses: astral-sh/setup-uv@v5
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install --upgrade twine build
- name: Lint with twine
Expand Down
Loading

0 comments on commit 712e7ed

Please sign in to comment.