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 dependency mkdocs to <1.4 #228

Merged
merged 1 commit into from
Mar 29, 2022
Merged

Update dependency mkdocs to <1.4 #228

merged 1 commit into from
Mar 29, 2022

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 29, 2022

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
mkdocs (source) <1.3 -> <1.4 age adoption passing confidence

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:

  • 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.


Configuration

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

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, 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 WhiteSource Renovate. View repository job log here.

@codecov
Copy link

codecov bot commented Mar 29, 2022

Codecov Report

Merging #228 (8b424d0) into main (23de76f) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #228   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          156       156           
=========================================
  Hits           156       156           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 23de76f...8b424d0. Read the comment docs.

@jackton1 jackton1 merged commit 43981e5 into main Mar 29, 2022
@jackton1 jackton1 deleted the renovate/mkdocs-1.x branch March 29, 2022 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants