build(deps): bump mkdocs from 1.4.3 to 1.5.0

dependabot[bot] commented 1 year ago

Bumps mkdocs from 1.4.3 to 1.5.0.

Release notes

1.5.0

New: MkDocs now accepts donations. Please consider supporting the current maintainer at my new GitHub sponsorship page.

MkDocs has been a totally free project since the beginning and wasn't accepting funds. MkDocs will remain free of paywalls, but now you can show your support with donations (one-time and/or recurring).

Donate for MkDocs - @oprypin sponsors page

And please also consider these other individuals who have been contributing to the ecosystem for a long time and check out their donations pages:

@facelessuser @pawamoy @Ultrabug

Release 1.5.0

New command mkdocs get-deps

This command guesses the Python dependencies that a MkDocs site requires in order to build. It simply prints the PyPI packages that need to be installed. In the terminal it can be combined directly with an installation command as follows:
pip install $(mkdocs get-deps)
The idea is that right after running this command, you can directly follow it up with mkdocs build and it will almost always "just work", without needing to think which dependencies to install.

The way it works is by scanning mkdocs.yml for themes:, plugins:, markdown_extensions: items and doing a reverse lookup based on a large list of known projects (catalog, see below).

Of course, you're welcome to use a "virtualenv" with such a command. Also note that for environments that require stability (for example CI) directly installing deps in this way is not a very reliable approach as it precludes dependency pinning.

The command allows overriding which config file is used (instead of mkdocs.yml in the current directory) as well as which catalog of projects is used (instead of downloading it from the default location). See mkdocs get-deps --help.

Context: #3205

MkDocs has an official catalog of plugins

Check out https://github.com/mkdocs/catalog and add all your general-purpose plugins, themes and extensions there, so that they can be looked up through mkdocs get-deps.

This was renamed from "best-of-mkdocs" and received significant updates. In addition to pip installation commands, the page now shows the config boilerplate needed to add a plugin.

Expanded validation of links

Validated links in Markdown

As you may know, within Markdown, MkDocs really only recognizes relative links that lead to another physical *.md document (or media file). This is a good convention to follow because then the source pages are also freely browsable without MkDocs, for example on GitHub. MkDocs knows that in the output it should turn those *.md links into *.html as appropriate, and it would also always tell you if such a link doesn't actually lead to an existing file.

However, the checks for links were really loose and had many concessions. For example, links that started with / ("absolute") and links that ended with / were left as is and no warning was shown, which allowed such very fragile links to sneak into site sources: links that happen to work right now but get no validation and links that confusingly need an extra level of .. with use_directory_urls enabled.

... (truncated)

Commits

0d9e341 Release 1.5.0 (#3296)
0f8ab6b Fix livereload shutdown sequence - crash on Windows
bfb52a3 Create FUNDING.yml (#3295)
189faf0 Merge pull request #3297 from mkdocs/regr
bb00d4c Add a test for relative link without dot in filename
c3d4ff7 Fix unescaping of Markdown titles
d8bc90f Always set inclusion_level so static-i18n plugin keeps working
8025445 Revert "Check types against older Click that still has correct types"
b1624b5 Add blockquote styling for mkdocs theme (#3291)
41de1dd The new !relative tag also needs to be ignored in get-deps
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)

github-actions[bot] commented 1 year ago

Test Results

36 tests 36 :heavy_check_mark: 1s :stopwatch:   1 suites   0 :zzz:   1 files   0 :x:

Results for commit a3832c88.

codecov[bot] commented 1 year ago

Codecov Report

Merging #694 (a3832c8) into dev (b1d2f59) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #694   +/-   ##
=======================================
  Coverage   97.66%   97.66%           
=======================================
  Files           1        1           
  Lines         171      171           
=======================================
  Hits          167      167           
  Misses          4        4

dependabot[bot] commented 1 year ago

Superseded by #695.

TomerFi / switcher_webapi