Update dependency mkdocs to v1.3.0 (main) #54

2022-03-28T07:03:58Z

renovate-bot commented

2022-03-28 07:03:58 +00:00

This PR contains the following updates:

Package	Update	Change
mkdocs (source)	minor	`==1.2.3` -> `==1.3.0`

Release Notes

mkdocs/mkdocs

`v1.3.0`

Compare Source

Feature upgrades

ReadTheDocs theme updated from v0.4.1 to v1.0.0 according to upstream (#2585)

The most notable changes:
- New option logo: Rather than displaying the site_name in the title, one can specify a path to an image to display instead.
- New option anonymize_ip for Google Analytics.
- Dependencies were upgraded: jQuery upgraded to 3.6.0, Modernizr.js dropped, and others.
See documentation of config options for the theme
Built-in themes now also support these languages:
- German (#2633)
- Persian (Farsi) (#2787)
Support custom directories to watch when running mkdocs serve (#2642)

MkDocs by default watches the docs directory and the config file. Now there is a way to add more directories to watch for changes, either via the YAML watch key or the command line flag --watch.

Normally MkDocs never reaches into any other directories (so this feature shouldn't be necessary), but some plugins and extensions may do so.

See documentation.
New --no-history option for gh_deploy (#2594)

Allows to discard the history of commits when deploying, and instead replace it with one root commit

Bug fixes

An XSS vulnerability when using the search function in built-in themes was fixed (#2791)
Setting the edit_uri option no longer erroneously adds a trailing slash to repo_url (#2733)

Miscellaneous

Breaking change: the pages config option that was deprecated for a very long time now causes an error when used (#2652)

To fix the error, just change from pages to nav.
Performance optimization: during startup of MkDocs, code and dependencies of other commands will not be imported (#2714)

The most visible effect of this is that dependencies of mkdocs serve will not be imported when mkdocs build is used.
Recursively validate nav (#2680)

Validation of the nested nav structure has been reworked to report errors early and reliably. Some edge cases have been declared invalid.

Other small improvements; see commit log.

`v1.2.4`

Compare Source

Compatibility with Jinja2 3.1.0 (#2800)

Due to a breaking change in Jinja2, MkDocs would crash with the message AttributeError: module 'jinja2' has no attribute 'contextfilter'

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Renovate Bot.

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [mkdocs](https://www.mkdocs.org) ([source](https://github.com/mkdocs/mkdocs)) | minor | `==1.2.3` -> `==1.3.0` | --- ### Release Notes <details> <summary>mkdocs/mkdocs</summary> ### [`v1.3.0`](https://github.com/mkdocs/mkdocs/releases/1.3.0) [Compare Source](https://github.com/mkdocs/mkdocs/compare/1.2.4...1.3.0) ##### Feature upgrades - ReadTheDocs theme updated from v0.4.1 to v1.0.0 according to upstream ([#2585](https://github.com/mkdocs/mkdocs/issues/2585)) The most notable changes: - New option `logo`: Rather than displaying the `site_name` in the title, one can specify a path to an image to display instead. - New option `anonymize_ip` for Google Analytics. - Dependencies were upgraded: jQuery upgraded to 3.6.0, Modernizr.js dropped, and others. See [documentation of config options for the theme](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) - Built-in themes now also support these languages: - German ([#2633](https://github.com/mkdocs/mkdocs/issues/2633)) - Persian (Farsi) ([#2787](https://github.com/mkdocs/mkdocs/issues/2787)) - Support custom directories to watch when running `mkdocs serve` ([#2642](https://github.com/mkdocs/mkdocs/issues/2642)) MkDocs by default watches the *docs* directory and the config file. Now there is a way to add more directories to watch for changes, either via the YAML `watch` key or the command line flag `--watch`. Normally MkDocs never reaches into any other directories (so this feature shouldn't be necessary), but some plugins and extensions may do so. See [documentation](https://www.mkdocs.org/user-guide/configuration/#watch). - New `--no-history` option for `gh_deploy` ([#2594](https://github.com/mkdocs/mkdocs/issues/2594)) Allows to discard the history of commits when deploying, and instead replace it with one root commit ##### Bug fixes - An XSS vulnerability when using the search function in built-in themes was fixed ([#2791](https://github.com/mkdocs/mkdocs/issues/2791)) - Setting the `edit_uri` option no longer erroneously adds a trailing slash to `repo_url` ([#2733](https://github.com/mkdocs/mkdocs/issues/2733)) ##### Miscellaneous - Breaking change: the `pages` config option that was deprecated for a very long time now causes an error when used ([#2652](https://github.com/mkdocs/mkdocs/issues/2652)) To fix the error, just change from `pages` to `nav`. - Performance optimization: during startup of MkDocs, code and dependencies of other commands will not be imported ([#2714](https://github.com/mkdocs/mkdocs/issues/2714)) The most visible effect of this is that dependencies of `mkdocs serve` will not be imported when `mkdocs build` is used. - Recursively validate `nav` ([#2680](https://github.com/mkdocs/mkdocs/issues/2680)) Validation of the nested `nav` structure has been reworked to report errors early and reliably. Some [edge cases](https://github.com/mkdocs/mkdocs/blob/b7272150bbc9bf8f66c878f6517742de3528972b/mkdocs/tests/config/config_options_tests.py#L783) have been declared invalid. Other small improvements; see [commit log](https://github.com/mkdocs/mkdocs/compare/1.2.3...1.3.0). ### [`v1.2.4`](https://github.com/mkdocs/mkdocs/releases/1.2.4) [Compare Source](https://github.com/mkdocs/mkdocs/compare/1.2.3...1.2.4) - Compatibility with Jinja2 3.1.0 ([#2800](https://github.com/mkdocs/mkdocs/issues/2800)) Due to a breaking change in Jinja2, MkDocs would crash with the message `AttributeError: module 'jinja2' has no attribute 'contextfilter'` </details> --- ### Configuration :date: **Schedule**: At any time (no schedule defined). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

renovate-bot added 1 commit 2022-03-28 07:04:03 +00:00

Update dependency mkdocs to v1.3.0

continuous-integration/drone/push Build is passing

Details

0a24424d32

decentral1se merged commit 0a24424d32 into main

2022-03-28 10:40:18 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/docs.coopcloud.tech#54