Skip to content

Commit ced40f3

Browse files
authored
Drop Mkdocs<1.4.0 support (#168)
1 parent 471f380 commit ced40f3

File tree

8 files changed

+11
-54
lines changed

8 files changed

+11
-54
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,7 @@ git push origin master
3333
git tag -a "v$version"
3434
git push origin "v$version"
3535
```
36+
37+
## Compatibility
38+
39+
Latest version supporting Python3.7 and Mkdocs<1.4.0 is v4.0.4.

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ plugins:
4040
- include-markdown
4141
```
4242
43-
> Make sure that you define `include-markdown` before other plugins that could
44-
> conflict, like [`mkdocs-macros-plugin`][mkdocs-macros-plugin-link].
45-
4643
### Configuration
4744
4845
The global behaviour of the plugin can be customized in the configuration.
@@ -251,6 +248,5 @@ Includes the content of a file or a group of files.
251248
[platformdirs]: https://pypi.org/project/platformdirs/
252249
[cibuildwheel-470]: https://github.com/joerick/cibuildwheel/issues/470
253250
[cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel
254-
[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io
255251
[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
256252
[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md

locale/es/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ plugins:
2828
- include-markdown
2929
```
3030
31-
> Asegúrate que defines `include-markdown` antes de otros plugins que pudieran
32-
entrar en conflicto, como [`mkdocs-macros-plugin`][mkdocs-macros-plugin-link].
33-
3431
### Configuración
3532
3633
El comportamiento global del plugin puede ser personalizado en la configuración.
@@ -244,6 +241,5 @@ separar este plugin de la documentación de
244241
[platformdirs]: https://pypi.org/project/platformdirs/
245242
[cibuildwheel-470]: https://github.com/joerick/cibuildwheel/issues/470
246243
[cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel
247-
[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io
248244
[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
249245
[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md

locale/es/README.md.po

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -83,19 +83,6 @@ msgstr ""
8383
msgid "Includes the content of a file or a group of files."
8484
msgstr "Incluye el contenido de un archivo o un grupo de archivos."
8585

86-
msgid ""
87-
"Make sure that you define `include-markdown` before other plugins that could"
88-
" conflict, like [`mkdocs-macros-plugin`][mkdocs-macros-plugin-link]."
89-
msgstr ""
90-
"Asegúrate que defines `include-markdown` antes de otros plugins que pudieran"
91-
" entrar en conflicto, como [`mkdocs-macros-plugin`][mkdocs-macros-plugin-"
92-
"link]."
93-
94-
msgid ""
95-
"[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io"
96-
msgstr ""
97-
"[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io"
98-
9986
msgid ""
10087
"[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-"
10188
"plugin/blob/master/locale/fr/README.md"

locale/fr/README.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,6 @@ plugins:
2828
- include-markdown
2929
```
3030
31-
> Assurez-vous de définir `include-markdown` avant d'autres plugins qui
32-
pourraient entrer en conflit, comme
33-
[`mkdocs-macros-plugin`][mkdocs-macros-plugin-link].
34-
3531
### Configuration
3632
3733
Le comportement global du plugin peut être personnalisé dans la configuration.
@@ -245,6 +241,5 @@ autorisations][cibuildwheel-470] pour séparer ce plugin de la documentation de
245241
[platformdirs]: https://pypi.org/project/platformdirs/
246242
[cibuildwheel-470]: https://github.com/joerick/cibuildwheel/issues/470
247243
[cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel
248-
[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io
249244
[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
250245
[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md

locale/fr/README.md.po

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,6 @@ msgstr "Préparation"
2020
msgid "Enable the plugin in your `mkdocs.yml`:"
2121
msgstr "Activer le plugin dans votre fichier `mkdocs.yml`:"
2222

23-
msgid ""
24-
"Make sure that you define `include-markdown` before other plugins that could"
25-
" conflict, like [`mkdocs-macros-plugin`][mkdocs-macros-plugin-link]."
26-
msgstr ""
27-
"Assurez-vous de définir `include-markdown` avant d'autres plugins qui "
28-
"pourraient entrer en conflit, comme [`mkdocs-macros-plugin`][mkdocs-macros-"
29-
"plugin-link]."
30-
3123
msgid "Reference"
3224
msgstr "Référence"
3325

@@ -84,11 +76,6 @@ msgstr ""
8476
msgid "[cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel"
8577
msgstr "[cibuildwheel-repo-link]: https://github.com/joerick/cibuildwheel"
8678

87-
msgid ""
88-
"[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io"
89-
msgstr ""
90-
"[mkdocs-macros-plugin-link]: https://mkdocs-macros-plugin.readthedocs.io"
91-
9279
msgid ""
9380
"[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-"
9481
"plugin/blob/master/locale/es/README.md"

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "mkdocs-include-markdown-plugin"
3-
version = "4.0.4"
3+
version = "5.0.0"
44
description = "Mkdocs Markdown includer plugin."
55
readme = "README.md"
66
license = "Apache-2.0"
@@ -70,15 +70,15 @@ dependencies = ["pytest~=7.0", "coverage~=6.4", "covdefaults"]
7070

7171
[[tool.hatch.envs.tests.matrix]]
7272
python = ["py38", "py39", "py310", "py311", "py312"]
73-
mkdocs = ["1.2.4", "1.3.1", "1.4.0", "1.4.2"]
73+
mkdocs = ["1.4.0", "1.4.3", "1.5.0", "1.5.1"]
7474
cache = ["yes", "no"]
7575

7676
[tool.hatch.envs.tests.overrides]
7777
matrix.mkdocs.dependencies = [
78-
{ value = "mkdocs==1.2.4", if = ["1.2.4"] },
79-
{ value = "mkdocs==1.3.1", if = ["1.3.1"] },
8078
{ value = "mkdocs==1.4.0", if = ["1.4.0"] },
81-
{ value = "mkdocs==1.4.2", if = ["1.4.2"] },
79+
{ value = "mkdocs==1.4.3", if = ["1.4.3"] },
80+
{ value = "mkdocs==1.5.0", if = ["1.5.0"] },
81+
{ value = "mkdocs==1.5.1", if = ["1.5.1"] },
8282
]
8383
matrix.cache.dependencies = [
8484
{ value = "platformdirs", if = ["yes"] },

src/mkdocs_include_markdown_plugin/plugin.py

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,13 @@
33
from __future__ import annotations
44

55
from collections.abc import Callable
6-
from typing import TYPE_CHECKING, Any, TypeVar, cast
6+
from typing import TYPE_CHECKING, Any, cast
77

88
from mkdocs.exceptions import BuildError
99
from mkdocs.livereload import LiveReloadServer
10-
from mkdocs.plugins import BasePlugin
10+
from mkdocs.plugins import BasePlugin, event_priority
1111

1212

13-
try:
14-
from mkdocs.plugins import event_priority
15-
except ImportError:
16-
T = TypeVar('T')
17-
18-
def event_priority(priority: float) -> Callable[[T], T]: # noqa: D103
19-
return lambda f: f
20-
2113
if TYPE_CHECKING:
2214
from mkdocs.config.defaults import MkDocsConfig
2315
from mkdocs.structure.files import Files

0 commit comments

Comments
 (0)