pls-cli
pls-cli copied to clipboard
⬆️ Bump mkdocs from 1.3.1 to 1.4.0
Bumps mkdocs from 1.3.1 to 1.4.0.
Release notes
Sourced from mkdocs's releases.
1.4.0
Feature upgrades
Hooks (#2978)
The new
hooks:
config allows you to add plugin-like event handlers from local Python files, without needing to set up and install an actual plugin.See documentation.
edit_uri
flexibility (#2927)There is a new
edit_uri_template:
config.
It works likeedit_uri
but more generally covers ways to construct an edit URL.
See documentation.Additionally, the
edit_uri
functionality will now fully work even ifrepo_url
is omitted (#2928)Upgrades for plugin developers
NOTE: This release has big changes to the implementation of plugins and their configs. But, the intention is to have zero breaking changes in all reasonably common use cases. Or at the very least if a code fix is required, there should always be a way to stay compatible with older MkDocs versions. Please report if this release breaks something.
Customize event order for plugin event handlers (#2973)
Plugins can now choose to set a priority value for their event handlers. This can override the old behavior where for each event type, the handlers are called in the order that their plugins appear in the
plugins
config.If this is set, events with higher priority are called first. Events without a chosen priority get a default of 0. Events that have the same priority are ordered as they appear in the config.
Recommended priority values:
100
"first",50
"early",0
"default",-50
"late",-100
"last".
As different plugins discover more precise relations to each other, the values should be further tweaked.See documentation.
New events that persist across builds in
mkdocs serve
(#2972)The new events are
on_startup
andon_shutdown
. They run at the very beginning and very end of anmkdocs
invocation.
on_startup
also receives information on howmkdocs
was invoked (e.g.serve
--dirtyreload
).See documentation.
Replace
File.src_path
to not deal with backslashes (#2930)The property
src_path
uses backslashes on Windows, which doesn't make sense as it's a virtual path.
To not make a breaking change, there's no change to how this property is used, but now you should:
- Use
File.src_uri
instead ofFile.src_path
- and
File.dest_uri
instead ofFile.dest_path
.These consistently use forward slashes, and are now the definitive source that MkDocs itself uses.
... (truncated)
Commits
927ee26
Release 1.4.0 (#2986)5cce501
Merge pull request #2962 from mkdocs/meta5015fa7
Add examples of class-based schema with ListOfItemscc627f7
Prevent wrapping into Optional when the option has a defaultaeffe61
Change config_options.URL's default from '' to None5156947
Add a test for subclassing a config schemaff8552a
Add tests for new class-based configs6d8c4d1
Preserve a copy of config_options_tests before reworking it452f56c
Move config_options_tests.py before reworking itcf9d237
Change ListOfItems' "default default" from [] to None- Additional commits viewable in compare view
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase
.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
-
@dependabot rebase
will rebase this PR -
@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it -
@dependabot merge
will merge this PR after your CI passes on it -
@dependabot squash and merge
will squash and merge this PR after your CI passes on it -
@dependabot cancel merge
will cancel a previously requested merge and block automerging -
@dependabot reopen
will reopen this PR if it is closed -
@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually -
@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) -
@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Codecov Report
Merging #40 (7a57a76) into main (7c6f206) will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## main #40 +/- ##
=======================================
Coverage 71.79% 71.79%
=======================================
Files 5 5
Lines 390 390
=======================================
Hits 280 280
Misses 110 110
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
Superseded by #47.