Skip to content

Commit 2183915

Browse files
oprypinoprypin
committed
Merge remote-tracking branch 'origin/master' into same
2 parents 6804532 + 8bea071 commit 2183915

File tree

333 files changed

+8412
-9423
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

333 files changed

+8412
-9423
lines changed

‎.codecov.yml‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.csslintrc‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎.gitattributes‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
mkdocs/contrib/search/lunr-language/** linguist-vendored
2-
mkdocs/themes/mkdocs/js/** linguist-vendored
3-
mkdocs/themes/mkdocs/js/base.js linguist-vendored=false
4-
mkdocs/themes/mkdocs/css/** linguist-vendored
5-
mkdocs/themes/mkdocs/css/base.css linguist-vendored=false
6-
mkdocs/themes/readthedocs/js/** linguist-vendored
7-
mkdocs/themes/readthedocs/js/theme.js linguist-vendored=false
8-
mkdocs/themes/readthedocs/css/** linguist-vendored
9-
mkdocs/themes/readthedocs/css/theme_extra.css linguist-vendored=false
1+
properdocs/contrib/search/lunr-language/** linguist-vendored
2+
packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/** linguist-vendored
3+
packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/js/base.js linguist-vendored=false
4+
packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/** linguist-vendored
5+
packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/css/base.css linguist-vendored=false
6+
packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/** linguist-vendored
7+
packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/js/theme.js linguist-vendored=false
8+
packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/** linguist-vendored
9+
packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/css/theme_extra.css linguist-vendored=false
1010
docs/img/plugin-events.svg linguist-generated

‎.github/FUNDING.yml‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.github/workflows/autofix.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Auto-fix
2+
on:
3+
push:
4+
pull_request:
5+
jobs:
6+
style:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Download source
10+
uses: actions/checkout@v6
11+
- name: Install Python
12+
uses: actions/setup-python@v6
13+
with:
14+
python-version: '3.13'
15+
- name: Install Hatch
16+
run: |
17+
pip install hatch
18+
- name: Install dependencies
19+
run: |
20+
hatch run style:pip freeze
21+
- name: Fix code style
22+
run: |
23+
hatch run style:fix --fix-only
24+
- name: Check if any edits are necessary
25+
run: |
26+
git diff --color --exit-code
27+
- name: Apply automatic fixes using pre-commit-ci-lite
28+
if: failure() && github.event_name == 'pull_request'
29+
uses: pre-commit-ci/lite-action@5d6cc0eb514c891a40562a58a8e71576c5c7fb43 # v1.1.0

‎.github/workflows/ci.yml‎

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,75 +4,95 @@ on:
44
pull_request:
55
schedule:
66
- cron: '0 6 * * 6'
7+
defaults:
8+
run:
9+
shell: bash
710
jobs:
811
test:
12+
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
913
strategy:
1014
fail-fast: false
1115
matrix:
12-
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.9-v7.x']
13-
os: [ubuntu-latest, windows-latest, macos-latest]
1416
include:
15-
- python-version: pypy-3.9-v7.x
16-
py: pypy3
17-
# Just to slim down the test matrix:
18-
exclude:
19-
- python-version: '3.9'
17+
- python: '3.14'
18+
os: ubuntu-latest
19+
- python: '3.14'
20+
os: windows-latest
21+
- python: '3.14'
2022
os: macos-latest
21-
- python-version: '3.9'
23+
- python: '3.13'
24+
os: ubuntu-latest
25+
- python: '3.13'
2226
os: windows-latest
23-
- python-version: '3.10'
27+
- python: '3.12'
28+
os: macos-latest
29+
- python: '3.12'
2430
os: ubuntu-latest
25-
- python-version: '3.11'
31+
- python: '3.12'
32+
os: windows-latest
33+
- python: '3.11'
34+
os: ubuntu-latest
35+
- python: '3.11'
36+
os: macos-latest
37+
- python: '3.10'
38+
os: ubuntu-latest
39+
- python: '3.10'
2640
os: macos-latest
27-
- python-version: '3.11'
41+
- python: '3.9'
2842
os: windows-latest
29-
runs-on: ${{ matrix.os }}
43+
- python: '3.9'
44+
os: ubuntu-latest
45+
versions: minimal
46+
runs-on: ${{matrix.os}}
3047
steps:
31-
- uses: actions/checkout@v4
32-
- name: Setup Python ${{ matrix.python-version }}
33-
uses: actions/setup-python@v4
48+
- name: Download source
49+
uses: actions/checkout@v6
50+
- name: Install Python
51+
uses: actions/setup-python@v6
3452
with:
35-
python-version: ${{ matrix.python-version }}
53+
python-version: ${{matrix.python}}
54+
- name: Pin to lowest versions
55+
if: matrix.versions == 'minimal'
56+
run: |
57+
sed -i -E 's/#min //; s/\b >=([0-9])/ ==\1/' pyproject.toml
58+
- name: Install Hatch
59+
run: |
60+
pip install hatch
3661
- name: Install dependencies
3762
run: |
38-
python -m pip install --upgrade hatch
63+
hatch run test:pip freeze
3964
- name: Run tests
4065
run: |
41-
hatch run +py=${{ matrix.py || matrix.python-version }} test:with-coverage
66+
hatch run +py=${{matrix.python}} test:test
4267
- name: Run integration tests
68+
if: matrix.versions != 'minimal'
4369
run: |
44-
hatch run +py=${{ matrix.py || matrix.python-version }} integration:test
45-
shell: bash
46-
- name: Upload Codecov Results
47-
if: success()
48-
uses: codecov/codecov-action@v3
49-
with:
50-
file: ./coverage.xml
51-
flags: unittests
52-
name: ${{ matrix.os }}/${{ matrix.python-version }}
53-
fail_ci_if_error: false
70+
hatch run +py=${{matrix.python}} integration:test
5471
55-
lint:
72+
style:
73+
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
5674
runs-on: ubuntu-latest
5775
steps:
58-
- uses: actions/checkout@v4
59-
- name: Setup Python
60-
uses: actions/setup-python@v4
76+
- name: Download source
77+
uses: actions/checkout@v6
78+
- name: Install Python
79+
uses: actions/setup-python@v6
6180
with:
62-
python-version: '3.11'
63-
- name: Install Python dependencies
81+
python-version: '3.13'
82+
- name: Install Hatch
6483
run: |
65-
python -m pip install --upgrade hatch
66-
- name: Setup Node
67-
uses: actions/setup-node@v4
84+
pip install hatch
85+
- name: Install Node
86+
uses: actions/setup-node@v6
6887
with:
69-
node-version: 20
88+
node-version: 24
89+
- name: Install dependencies
90+
run: |
91+
hatch run style:pip freeze
92+
hatch run types:pip freeze
7093
- name: Check with ruff
7194
if: always()
72-
run: hatch run style:fix
73-
- name: Check with black + isort
74-
if: always()
75-
run: hatch run style:format && git diff --color --exit-code
95+
run: hatch run style:check
7696
- name: Check with mypy
7797
if: always()
7898
run: hatch run types:check
@@ -82,29 +102,27 @@ jobs:
82102
- name: Check JS style
83103
if: always()
84104
run: hatch run lint:js
85-
- name: Check CSS style
86-
if: always()
87-
run: hatch run lint:css
88105
- name: Check spelling
89106
if: always()
90107
run: hatch run lint:spelling
91108

92109
package:
110+
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
93111
runs-on: ubuntu-latest
94112
steps:
95-
- uses: actions/checkout@v4
113+
- uses: actions/checkout@v6
96114
- name: Setup Python
97-
uses: actions/setup-python@v4
115+
uses: actions/setup-python@v6
98116
with:
99-
python-version: '3.11'
117+
python-version: '3.13'
100118
- name: Install dependencies
101119
run: pip install -U build
102120
- name: Build package
103121
run: python -m build
104122
- name: Check packaged files
105123
shell: bash -e -x {0}
106124
run: |
107-
expected_wheel=(-emkdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js,themes/{mkdocs,readthedocs}/{base.html,locales/{de,es}/LC_MESSAGES/messages.mo}})
108-
expected_sdist=("${expected_wheel[@]}" -e{pyproject.toml,hatch_build.py})
109-
test "$(tar -ztf dist/mkdocs-*.tar.gz | grep -F "${expected_sdist[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_sdist[@]}"
110-
test "$(unzip -l dist/mkdocs-*any.whl | grep -F "${expected_wheel[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_wheel[@]}"
125+
expected_wheel=(-eproperdocs/{templates/sitemap.xml,config/base.py,py.typed,contrib/search/lunr-language/lunr.nl.js})
126+
expected_sdist=("${expected_wheel[@]}" -epyproject.toml)
127+
test "$(tar -ztf dist/properdocs-*.tar.gz | grep -F "${expected_sdist[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_sdist[@]}"
128+
test "$(unzip -l dist/properdocs-*any.whl | grep -F "${expected_wheel[@]}" | tee /dev/stderr | wc -l)" -eq "${#expected_wheel[@]}"

‎.github/workflows/deploy-docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy docs
2+
on:
3+
push:
4+
pull_request:
5+
schedule:
6+
- cron: '0 6 * * 6'
7+
jobs:
8+
build:
9+
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Download source
13+
uses: actions/checkout@v6
14+
- name: Install Python
15+
uses: actions/setup-python@v6
16+
with:
17+
python-version: '3.13'
18+
- name: Install dependencies
19+
run: pip install --no-deps -r requirements/requirements-docs.txt && pip install .
20+
- name: Build site
21+
run: properdocs build --strict
22+
- name: Upload to GitHub Pages
23+
uses: actions/upload-pages-artifact@v4
24+
with:
25+
path: site
26+
deploy:
27+
if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
28+
needs: build
29+
permissions:
30+
pages: write
31+
id-token: write
32+
runs-on: ubuntu-latest
33+
steps:
34+
- name: Deploy to GitHub Pages
35+
id: deployment
36+
uses: actions/deploy-pages@v4
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}

‎.github/workflows/deploy-release.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ jobs:
99
id-token: write
1010
runs-on: ubuntu-latest
1111
steps:
12-
- uses: actions/checkout@v4
12+
- uses: actions/checkout@v6
1313
- name: Setup Python
14-
uses: actions/setup-python@v4
14+
uses: actions/setup-python@v6
1515
with:
16-
python-version: '3.11'
16+
python-version: '3.13'
1717
- name: Install dependencies
1818
run: pip install -U build
1919
- name: Build package

‎.github/workflows/docs.yml‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ target/
6666
venv/
6767
ENV/
6868

69-
# MkDocs documentation
69+
# ProperDocs documentation
7070
site*/

0 commit comments

Comments
 (0)