Skip to content

Commit 43f599d

Browse files
committed
Initial commit.
1 parent 7448707 commit 43f599d

File tree

12 files changed

+127
-118
lines changed

12 files changed

+127
-118
lines changed

.github/workflows/conda_ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
python -VV
3838
python -m site
3939
python -m pip install --upgrade pip setuptools wheel
40-
python -m pip install --upgrade "whey-conda" "whey"
40+
python -m pip install --upgrade "whey-conda" "whey" "whey-pth"
4141
# $CONDA is an environment variable pointing to the root of the miniconda directory
4242
$CONDA/bin/conda update -n base conda
4343
$CONDA/bin/conda config --add channels conda-forge

.github/workflows/flake8.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
if: steps.changes.outputs.code == 'true'
3636
uses: "actions/setup-python@v2"
3737
with:
38-
python-version: "3.6"
38+
python-version: "3.7"
3939

4040
- name: Install dependencies 🔧
4141
if: steps.changes.outputs.code == 'true'

.github/workflows/mypy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
if: steps.changes.outputs.code == 'true'
4141
uses: "actions/setup-python@v2"
4242
with:
43-
python-version: "3.6"
43+
python-version: "3.7"
4444

4545
- name: Install dependencies 🔧
4646
run: |

.github/workflows/python_ci.yml

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,20 @@ jobs:
2222
runs-on: "windows-2019"
2323
continue-on-error: ${{ matrix.config.experimental }}
2424
env:
25-
USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.6,pypy-3.7,pypy-3.8,pypy-3.9'
25+
USING_COVERAGE: '3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.7,pypy-3.8,pypy-3.9'
2626

2727
strategy:
2828
fail-fast: False
2929
matrix:
3030
config:
31-
- {python-version: "3.6", testenvs: "py36-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
32-
- {python-version: "3.7", testenvs: "py37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
33-
- {python-version: "3.8", testenvs: "py38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
34-
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
35-
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
36-
- {python-version: "3.11.0-alpha.6", testenvs: "py311-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
37-
- {python-version: "pypy-3.6", testenvs: "pypy36-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
38-
- {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
39-
- {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
40-
- {python-version: "pypy-3.9", testenvs: "pypy39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4}", experimental: True}
31+
- {python-version: "3.7", testenvs: "py37-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
32+
- {python-version: "3.8", testenvs: "py38-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
33+
- {python-version: "3.9", testenvs: "py39-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
34+
- {python-version: "3.10", testenvs: "py310-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
35+
- {python-version: "3.11.0-alpha.6", testenvs: "py311-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
36+
- {python-version: "pypy-3.7", testenvs: "pypy37-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
37+
- {python-version: "pypy-3.8", testenvs: "pypy38-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
38+
- {python-version: "pypy-3.9", testenvs: "pypy39-jinja2{3.1,3.0,2.11,2.10}", experimental: True}
4139

4240
steps:
4341
- name: Checkout 🛎️

.github/workflows/python_ci_linux.yml

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,20 @@ jobs:
2323
runs-on: "ubuntu-20.04"
2424
continue-on-error: ${{ matrix.config.experimental }}
2525
env:
26-
USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.6,pypy-3.7,pypy-3.8,pypy-3.9'
26+
USING_COVERAGE: '3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.7,pypy-3.8,pypy-3.9'
2727

2828
strategy:
2929
fail-fast: False
3030
matrix:
3131
config:
32-
- {python-version: "3.6", testenvs: "py36-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
33-
- {python-version: "3.7", testenvs: "py37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
34-
- {python-version: "3.8", testenvs: "py38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
35-
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
36-
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
37-
- {python-version: "3.11.0-alpha.6", testenvs: "py311-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
38-
- {python-version: "pypy-3.6", testenvs: "pypy36-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
39-
- {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
40-
- {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
41-
- {python-version: "pypy-3.9", testenvs: "pypy39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4}", experimental: True}
32+
- {python-version: "3.7", testenvs: "py37-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
33+
- {python-version: "3.8", testenvs: "py38-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
34+
- {python-version: "3.9", testenvs: "py39-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
35+
- {python-version: "3.10", testenvs: "py310-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
36+
- {python-version: "3.11.0-alpha.6", testenvs: "py311-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
37+
- {python-version: "pypy-3.7", testenvs: "pypy37-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
38+
- {python-version: "pypy-3.8", testenvs: "pypy38-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
39+
- {python-version: "pypy-3.9", testenvs: "pypy39-jinja2{3.1,3.0,2.11,2.10}", experimental: True}
4240

4341
steps:
4442
- name: Checkout 🛎️
@@ -144,7 +142,7 @@ jobs:
144142
python -VV
145143
python -m site
146144
python -m pip install --upgrade pip setuptools wheel
147-
python -m pip install --upgrade "mkrecipe" "whey"
145+
python -m pip install --upgrade "mkrecipe" "whey" "whey-pth"
148146
# $CONDA is an environment variable pointing to the root of the miniconda directory
149147
$CONDA/bin/conda config --set always_yes yes --set changeps1 no
150148
$CONDA/bin/conda update -n base conda

.github/workflows/python_ci_macos.yml

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,20 @@ jobs:
2222
runs-on: "macos-latest"
2323
continue-on-error: ${{ matrix.config.experimental }}
2424
env:
25-
USING_COVERAGE: '3.6,3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.7,pypy-3.8,pypy-3.9'
25+
USING_COVERAGE: '3.7,3.8,3.9,3.10,3.11.0-alpha.6,pypy-3.7,pypy-3.8,pypy-3.9'
2626

2727
strategy:
2828
fail-fast: False
2929
matrix:
3030
config:
31-
- {python-version: "3.6", testenvs: "py36-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
32-
- {python-version: "3.7", testenvs: "py37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
33-
- {python-version: "3.8", testenvs: "py38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
34-
- {python-version: "3.9", testenvs: "py39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
35-
- {python-version: "3.10", testenvs: "py310-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
36-
- {python-version: "3.11.0-alpha.6", testenvs: "py311-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: False}
37-
- {python-version: "pypy-3.7", testenvs: "pypy37-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
38-
- {python-version: "pypy-3.8", testenvs: "pypy38-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4},build", experimental: True}
39-
- {python-version: "pypy-3.9", testenvs: "pypy39-sphinx{3.2,3.3,3.4,3.5,4.0,4.1,4.2,4.3,4.4}", experimental: True}
31+
- {python-version: "3.7", testenvs: "py37-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
32+
- {python-version: "3.8", testenvs: "py38-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
33+
- {python-version: "3.9", testenvs: "py39-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
34+
- {python-version: "3.10", testenvs: "py310-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
35+
- {python-version: "3.11.0-alpha.6", testenvs: "py311-jinja2{3.1,3.0,2.11,2.10},build", experimental: False}
36+
- {python-version: "pypy-3.7", testenvs: "pypy37-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
37+
- {python-version: "pypy-3.8", testenvs: "pypy38-jinja2{3.1,3.0,2.11,2.10},build", experimental: True}
38+
- {python-version: "pypy-3.9", testenvs: "pypy39-jinja2{3.1,3.0,2.11,2.10}", experimental: True}
4039

4140
steps:
4241
- name: Checkout 🛎️

formate.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ lines_between_types = 0
3131
use_parentheses = true
3232
remove_redundant_aliases = true
3333
default_section = "THIRDPARTY"
34-
known_third_party = []
34+
known_third_party = [ "jinja2", "markupsafe",]
3535
known_first_party = "sphinx_jinja2_compat"

pyproject.toml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
[build-system]
2-
requires = [ "whey",]
2+
requires = [ "whey", "whey-pth",]
33
build-backend = "whey"
44

55
[project]
66
name = "sphinx-jinja2-compat"
77
version = "0.0.0"
88
description = "Patches Jinja2 v3 to restore compatibility with earlier Sphinx versions."
99
readme = "README.rst"
10+
requires-python = ">=3.6"
1011
keywords = [ "documentation", "jinja2", "sphinx",]
11-
dynamic = [ "requires-python", "classifiers", "dependencies",]
12+
dynamic = [ "classifiers", "dependencies",]
1213

1314
[[project.authors]]
1415
name = "Dominic Davis-Foster"
@@ -35,16 +36,17 @@ base-classifiers = [
3536
"Topic :: Documentation :: Sphinx",
3637
"Topic :: Software Development :: Documentation",
3738
]
38-
python-versions = [ "3.6", "3.7", "3.8", "3.9", "3.10", "3.11",]
39+
python-versions = [ "3.7", "3.8", "3.9", "3.10", "3.11",]
3940
python-implementations = [ "CPython", "PyPy",]
4041
platforms = [ "Windows", "macOS", "Linux",]
4142
license-key = "MIT"
4243
package = "sphinx_jinja2_compat"
4344

4445
[tool.importcheck]
46+
always = [ "sphinx_jinja2_compat",]
4547

4648
[tool.mypy]
47-
python_version = "3.6"
49+
python_version = "3.7"
4850
namespace_packages = true
4951
check_untyped_defs = true
5052
warn_unused_ignores = true
@@ -54,6 +56,13 @@ show_error_codes = true
5456
[tool.snippet-fmt]
5557
directives = [ "code-block",]
5658

59+
[tool.whey-pth]
60+
name = "_sphinx_jinja2_compat"
61+
pth-content = "import sphinx_jinja2_compat"
62+
63+
[tool.whey.builders]
64+
wheel = "whey_pth_wheel"
65+
5766
[tool.dependency-dash."requirements.txt"]
5867
order = 10
5968

repo_helper.yml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,29 @@ short_desc: "Patches Jinja2 v3 to restore compatibility with earlier Sphinx vers
1313
use_whey: true
1414
enable_docs: False
1515
enable_tests: False
16+
requires_python: 3.6
17+
python_deploy_version: 3.7
1618

1719
conda_channels:
1820
- conda-forge
1921

2022
# Versions to run tests for
2123
python_versions:
22-
- 3.6
2324
- 3.7
2425
- 3.8
2526
- 3.9
2627
- "3.10"
2728
- 3.11
28-
- pypy36
2929
- pypy37
3030
- pypy38
3131
- pypy39
3232

3333
third_party_version_matrix:
34-
sphinx:
35-
- 3.2
36-
- 3.3
37-
- 3.4
38-
- 3.5
39-
- 4.0
40-
- 4.1
41-
- 4.2
42-
- 4.3
43-
- 4.4
4434
jinja2:
4535
- 3.1
4636
- 3.0
47-
- 2.11
37+
- "2.11"
38+
- "2.10"
4839

4940
classifiers:
5041
- 'Development Status :: 3 - Alpha'
@@ -57,3 +48,6 @@ keywords:
5748
- sphinx
5849
- jinja2
5950
- documentation
51+
52+
tox_unmanaged:
53+
- testenv

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
jinja2>=2.10
2+
markupsafe>=1

0 commit comments

Comments
 (0)