Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update mkdocs to 1.3.0 #1203

Merged
merged 1 commit into from
Mar 30, 2022
Merged

Conversation

pyup-bot
Copy link
Contributor

This PR updates mkdocs from 1.2.3 to 1.3.0.

Changelog

1.3.0

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](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs)

* 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](https://www.mkdocs.org/user-guide/configuration/#watch).

* 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](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).

1.2.4

* 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'`
Links

@pyup-bot pyup-bot requested review from a team and bkizer-tenable as code owners March 26, 2022 20:46
@codecov
Copy link

codecov bot commented Mar 26, 2022

Codecov Report

Merging #1203 (9095ac9) into master (f8c0343) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1203   +/-   ##
=======================================
  Coverage   78.39%   78.39%           
=======================================
  Files         271      271           
  Lines        7509     7509           
=======================================
  Hits         5887     5887           
  Misses       1287     1287           
  Partials      335      335           

@Rchanger Rchanger force-pushed the pyup-update-mkdocs-1.2.3-to-1.3.0 branch from dacc919 to 9095ac9 Compare March 30, 2022 10:11
@sonarcloud
Copy link

sonarcloud bot commented Mar 30, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@cesar-rodriguez cesar-rodriguez merged commit 830e079 into master Mar 30, 2022
@cesar-rodriguez cesar-rodriguez deleted the pyup-update-mkdocs-1.2.3-to-1.3.0 branch March 30, 2022 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants