2033 Commits

Author SHA1 Message Date
Muescha
635dfc1a33 Docs: fix twitter link in the footer (#3094) 2023-04-21 22:15:26 +02:00
Oleh Prypin
7d32815367 Apply the same to mkdocs theme 2023-04-21 22:04:49 +02:00
少个分号
5de7903c5a fix wrong translation for zh 2023-04-21 22:04:49 +02:00
Henock Teshome
9e12a521e0 Use f-string in another place (#3156) 2023-04-21 19:27:23 +02:00
Mark De Ruyter
c32ce4d923 Fixes Page class references in documentation (#3117)
mkdocs.nav.Pages => mkdocs.structure.pages.Page
2023-04-21 19:18:45 +02:00
Steven Maude
49fbc35d11 Correct capitalisation of "GitHub Pages" (#3037)
To be consistent with GitHub's usage, and the use in MkDocs' documentation elsewhere.
2023-04-21 19:17:35 +02:00
Hélène Martin
0c1e9917a5 Align edit_url text and example (#3124) 2023-04-21 19:16:47 +02:00
Y.D.X
487e292dcc Docs: Fix indents in the example code (#3139) 2023-04-21 19:14:15 +02:00
Elisei Roca
0e6a1c204c Remove executable bit from tests/__init__.py (#3107) 2023-04-21 19:13:33 +02:00
Oleh Prypin
25cfda3fe7 Fix type annotations according to mypy 2023-04-10 21:25:00 +02:00
Oleh Prypin
11f8f3a2a3 Spelling fix 2023-04-10 21:24:55 +02:00
Oleh Prypin
07a297b3b4 Skip entries with missing abs_url from sitemap 2023-04-10 21:23:12 +02:00
HankB
56b235a8ad Docs: add warning about uncommitted changes (#3034) 2022-11-07 00:57:33 +01:00
Oleh Prypin
ec7eee6ce3 Release 1.4.2 (#3032) 1.4.2 2022-11-01 19:23:29 +01:00
Oleh Prypin
c99ec45a32 Support multiple instances of the same plugin (#3027)
Depending on what a plugin does, say if it "adds a thing" into the site, it can be reasonable to allow it to be specified multiple times in the `plugins:` list, so it can "add multiple things". Previously such a use case was completely not predicted in MkDocs, so it silently passes but is bugged - the plugin runs twice but with only one of the configs both times.

So, this commit addresses that by registering a plugin `- foo:` as `'foo'`, and then if another plugin `- foo:` appears, it gets registered as `'foo #2'` (the name affects primarily just how it's referred to in warnings and errors).

By default, a warning will appear from MkDocs anyway, unless the plugin adds a class variable `supports_multiple_instances = True`.
2022-11-01 18:53:43 +01:00
Oleh Prypin
452c39eae2 Chore dependency upgrade 2022-10-29 22:44:38 +02:00
pcgaustad
f190c35a99 Translate mkdocs theme to Norwegian (nb and nn) (#3024) 2022-10-29 14:55:02 +02:00
Oleh Prypin
c576f07d30 Declare support for Python 3.11 (#3020) 2022-10-29 14:48:00 +02:00
Oleh Prypin
32359f3e93 Relative links end with slash even for homepage links (#3022)
Fixes #3015
2022-10-29 14:41:50 +02:00
Oleh Prypin
1fa2af7926 Expand type checking coverage (#3019) 2022-10-25 21:59:30 +02:00
Oleh Prypin
d76cae9059 Merge pull request #3016 from mkdocs/optw
Update warnings of config options
2022-10-23 17:57:29 +02:00
Oleh Prypin
9d73c2a824 Reduce redundancy in config errors/warnings 2022-10-21 22:29:42 +02:00
Oleh Prypin
427d553c2b Let plugins put strings into warnings
even though they should be 2-tuples.

Fixes #3014
2022-10-21 22:27:22 +02:00
Oleh Prypin
0584e51e7d Chore dependency upgrade 2022-10-16 16:27:32 +02:00
Oleh Prypin
faba3f046e Add missed entry in release notes 2022-10-15 21:29:03 +02:00
Oleh Prypin
aa9eabea1a Release 1.4.1 (#3004) 1.4.1 2022-10-15 21:13:41 +02:00
Blueswen
79fa445717 URL-encode paths when serving a redirect (#3001)
Co-authored-by: Oleh Prypin <oleh@pryp.in>
2022-10-14 00:48:47 +02:00
Oleh Prypin
64c42a6943 Fix tests for previous commit 2022-10-14 00:45:17 +02:00
Oleh Prypin
6b7d0a55e0 Prevent a confusing stack trace when theme config fails validation
Caused by previous commit.
When, for example, the chosen theme is not installed, a stack trace would be shown instead of a proper error. Because then somehow the theme config remains a dict but validation moves on anyway.
2022-10-14 00:23:55 +02:00
Oleh Prypin
6fca6b59a2 Support theme-namespaced plugin loading (#2998)
This is mainly aimed at 'material' theme which also ships plugins with it. It will be able to ship plugins under the name e.g. 'material/search' and that will ensure the following effects:

* If the current theme is 'material', the plugin 'material/search' will always be preferred over 'search'.
* If the current theme *isn't* 'material', the only way to use this plugin is by specifying `plugins: [material/search]`.

One can also specify `plugins: ['/search']` instead of `plugins: ['search']` to definitely avoid the theme-namespaced plugin.

Previously:
* #2591

@squidfunk
2022-10-12 03:54:40 +02:00
Oleh Prypin
568e63ec3f Merge pull request #2997 from mkdocs/plugconf
Refactor plugin-related config options and error reporting
2022-10-11 21:51:50 -04:00
Oleh Prypin
aaf819f183 Better guard an edge case in plugin config 2022-10-08 15:07:34 +02:00
Oleh Prypin
b964e05372 Refactor load_plugin usage 2022-10-08 14:56:20 +02:00
Oleh Prypin
9ada9bf969 Also tighten warnings of plugin configs 2022-10-08 14:56:20 +02:00
Oleh Prypin
6b4d20e1eb Refactor plugin_cache usage to avoid nested exception 2022-10-08 14:49:04 +02:00
Oleh Prypin
ca8a3c8d67 Tighten warnings and type annotations in config_options 2022-10-08 14:49:04 +02:00
Oleh Prypin
76709ab540 Expand plugin testing 2022-10-08 14:49:04 +02:00
Oleh Prypin
7a72282f8a Refactor Theme config option to use mainly run_validation 2022-10-08 14:48:46 +02:00
Oleh Prypin
b2083d07f5 Add CLI reference page, auto-generated from Click (#2996) 2022-10-08 11:17:05 +02:00
Oleh Prypin
aa10190a55 Migrate from Tox to Hatch as test runner (#2991) 2022-10-07 23:18:05 +02:00
Oleh Prypin
65c24c21f0 Integrate Babel build steps as a Hatch hook (#2992) 2022-10-07 18:07:35 +02:00
Oleh Prypin
30cdac47a9 Switch to pyproject.toml and Hatch build (#2988) 2022-10-07 00:42:48 +02:00
Oleh Prypin
12ee265cc1 Remove pybabel setuptools integration (#2990) 2022-10-03 19:30:02 +02:00
Oleh Prypin
f2c648b35f Fix tests that wrote something into the source directory 2022-10-03 01:22:25 +02:00
Oleh Prypin
418d23a4da Actually depend on 'colorama' on Windows (#2987)
This was missed in #2606
2022-10-02 20:14:06 +02:00
Oleh Prypin
1a43c4a111 Remove unused FontAwesome.otf 2022-10-02 15:03:12 +02:00
Oleh Prypin
4dd64a6950 Mention event priority values also in release notes 2022-09-27 20:00:35 +02:00
Oleh Prypin
927ee2684b Release 1.4.0 (#2986) 1.4.0 2022-09-27 19:26:54 +02:00
Oleh Prypin
5cce5012b4 Merge pull request #2962 from mkdocs/meta
Rework ConfigOption schemas as class-based
2022-09-26 14:25:18 +02:00
Oleh Prypin
5015fa72af Add examples of class-based schema with ListOfItems 2022-09-26 11:35:24 +02:00