-
Notifications
You must be signed in to change notification settings - Fork 0
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 all dependencies #3
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6d60a88
to
74ebfc5
Compare
2c8b2a7
to
6c9b690
Compare
d77a5a7
to
4f67d27
Compare
9294e2c
to
5d9fa22
Compare
e3832c2
to
a892ac2
Compare
d0eeaa0
to
f0d2724
Compare
04da106
to
122e6a8
Compare
52244f0
to
efe3ea7
Compare
af69457
to
9f5a6be
Compare
91b86f1
to
718c031
Compare
9d587ee
to
a0ff80b
Compare
1e3d486
to
c613fe7
Compare
9b3dbae
to
de00929
Compare
abc5b37
to
98c2983
Compare
b4103d9
to
2684c7f
Compare
2684c7f
to
340e4f1
Compare
1fd3597
to
3af543b
Compare
3da9f3b
to
3436d24
Compare
3436d24
to
44a8686
Compare
44a8686
to
9dbcfa0
Compare
9dbcfa0
to
d7ee6d3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
automerge
Allow automatic Merge.
chore
Maintenance
cicd
ci/cd process functionality.
dependencies
Pull requests that update a dependency file.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==1.5.3
->==1.6.1
==6.0.4
->==7.1.2
==9.5.3
->==9.5.49
v1.13.0
->v1.14.0
v1.1.7
->v1.1.10
==3.6.0
->==4.0.1
v4.5.0
->v5.0.0
==10.7
->==10.12
v1.1
->v1.2
Note: The
pre-commit
manager in Renovate is not supported by thepre-commit
maintainers or community. Please do not report any problems there, instead create a Discussion in the Renovate repository if you have any questions.Release Notes
mkdocs/mkdocs (mkdocs)
v1.6.1
Compare Source
Version 1.6.1 (Friday 30th August, 2024)
Fixed
SOURCE_DATE_EPOCH=0
is set. #3795mkdocs_theme.yml
config is empty. #3700python -W
andPYTHONWARNINGS
instead of overriding the configuration. #38090.0.0.0
dev server warning. #3784changefreq
fromsitemap.xml
. #3629Added
v1.6.0
Compare Source
Local preview
mkdocs serve
no longer locks up the browser when more than 5 tabs are open. This is achieved by closing the polling connection whenever a tab becomes inactive. Background tabs will no longer auto-reload either - that will instead happen as soon the tab is opened again. Context: #3391New flag
serve --open
to open the site in a browser.After the first build is finished, this flag will cause the default OS Web browser to be opened at the home page of the local site.
Context: #3500
Drafts
The
exclude_docs
config no longer has any special behavior formkdocs serve
- it now always completely excludes the listed documents from the site.If you wish to use the "drafts" functionality like the
exclude_docs
key used to do in MkDocs 1.5, please switch to the new config keydraft_docs
.See documentation.
Other changes:
Update to deduction of page titles
MkDocs 1.5 had a change in behavior in deducing the page titles from the first heading. Unfortunately this could cause unescaped HTML tags or entities to appear in edge cases.
Now tags are always fully sanitized from the title. Though it still remains the case that
Page.title
is expected to contain HTML entities and is passed directly to the themes.Images (notably, emojis in some extensions) get preserved in the title only through their
alt
attribute's value.Context: #3564, #3578
Themes
"readthedocs" theme
Fix: "readthedocs" theme can now correctly handle deeply nested nav configurations (over 2 levels deep), without confusedly expanding all sections and jumping around vertically. (#3464)
Fix: "readthedocs" theme now shows a link to the repository (with a generic logo) even when isn't one of the 3 known hosters. (#3435)
"readthedocs" theme now also has translation for the word "theme" in the footer that mistakenly always remained in English. (#3613, #3625)
"mkdocs" theme
The "mkdocs" theme got a big update to a newer version of Bootstrap, meaning a slight overhaul of styles. Colors (most notably of admonitions) have much better contrast.
The "mkdocs" theme now has support for dark mode - both automatic (based on the OS/browser setting) and with a manual toggle. Both of these options are not enabled by default and need to be configured explicitly.
See
color_mode
,user_color_mode_toggle
in documentation.Context: #3493, #3649
Configuration
New "
enabled
" setting for all pluginsYou may have seen some plugins take up the convention of having a setting
enabled: false
(or usually controlled through an environment variable) to make the plugin do nothing.Now every plugin has this setting. Plugins can still choose to implement this config themselves and decide how it behaves (and unless they drop older versions of MkDocs, they still should for now), but now there's always a fallback for every plugin.
See documentation. Context: #3395
Validation
Validation of hyperlinks between pages
Absolute links
If you dislike having to always use relative links, now you can opt into absolute links and have them work correctly.
If you set the setting
validation.links.absolute_links
to the new valuerelative_to_docs
, all Markdown links starting with/
will be understood as being relative to thedocs_dir
root. The links will then be validated for correctness according to all the other rules that were already working for relative links in prior versions of MkDocs. For the HTML output, these links will still be turned relative so that the site still works reliably.So, now any document (e.g. "dir1/foo.md") can link to the document "dir2/bar.md" as
[link](/dir2/bar.md)
, in addition to the previously only correct way[link](../dir2/bar.md)
.You have to enable the setting, though. The default is still to just skip any processing of such links.
See documentation. Context: #3485
Absolute links within nav
Absolute links within the
nav:
config were also always skipped. It is now possible to also validate them in the same way withvalidation.nav.absolute_links
. Though it makes a bit less sense because then the syntax is simply redundant with the syntax that comes without the leading slash.Anchors
There is a new config setting that is recommended to enable warnings for:
Example of a warning that this can produce:
Any of the below methods of declaring an anchor will be detected by MkDocs:
Plugins and extensions that insert anchors, in order to be compatible with this, need to be developed as treeprocessors that insert
etree
elements as their mode of operation, rather than raw HTML which is undetectable for this purpose.If you as a user are dealing with falsely reported missing anchors and there's no way to resolve this, you can choose to disable these messages by setting this option to
ignore
(and they are at INFO level by default anyway).See documentation. Context: #3463
Other changes:
When the
nav
config is not specified at all, thenot_in_nav
setting (originally added in 1.5.0) gains an additional behavior: documents covered bynot_in_nav
will not be part of the automatically deduced navigation. Context: #3443Fix: the
!relative
YAML tag formarkdown_extensions
(originally added in 1.5.0) - it was broken in many typical use cases.See documentation. Context: #3466
Config validation now exits on first error, to avoid showing bizarre secondary errors. Context: #3437
MkDocs used to shorten error messages for unexpected errors such as "file not found", but that is no longer the case, the full error message and stack trace will be possible to see (unless the error has a proper handler, of course). Context: #3445
Upgrades for plugin developers
Plugins can add multiple handlers for the same event type, at multiple priorities
See
mkdocs.plugins.CombinedEvent
in documentation. Context: #3448Enabling true generated files and expanding the
File
APISee documentation.
There is a new pair of attributes
File.content_string
that becomes the official API for obtaining the content of a file and is used by MkDocs itself.This replaces the old approach where one had to manually read the file located at
File.abs_src_path
, although that is still the primary action that these new attributes do under the hood.The content of a
File
can be backed by a string and no longer has to be a real existing file atabs_src_path
.It is possible to set the attribute
File.content_string
orFile.content_bytes
and it will take precedence overabs_src_path
.Further,
abs_src_path
is no longer guaranteed to be present and can beNone
instead. MkDocs itself still uses physical files in all cases, but eventually plugins will appear that don't populate this attribute.There is a new constructor
File.generated()
that should be used by plugins instead of theFile()
constructor. It is much more convenient because one doesn't need to manually look up the values such asdocs_dir
anduse_directory_urls
. Its signature is one of:This way, it is now extremely easy to add a virtual file even from a hook:
For large content it is still best to use physical files, but one no longer needs to manipulate the path by providing a fake unused
docs_dir
.There is a new attribute
File.generated_by
that arose by convention - for generated files it should be set to the name of the plugin (the key in theplugins:
collection) that produced this file. This attribute is populated automatically when using theFile.generated()
constructor.It is possible to set the
edit_uri
attribute of aFile
, for example from a plugin or hook, to make it different from the default (equal tosrc_uri
), and this will be reflected in the edit link of the document. This can be useful because some pages aren't backed by a real file and are instead created dynamically from some other source file or script. So a hook could set theedit_uri
to that source file or script accordingly.The
File
object now stores its originalsrc_dir
,dest_dir
,use_directory_urls
values as attributes.Fields of
File
are computed on demand but cached. Only the three above attributes are primary ones, and partly alsodest_uri
. This way, it is possible to, for example, overwritedest_uri
of aFile
, andabs_dest_path
will be calculated based on it. However you need to clear the attribute first usingdel f.abs_dest_path
, because the values are cached.File
instances are now hashable (can be used as keys of adict
). Two files can no longer be considered "equal" unless it's the exact same instance ofFile
.Other changes:
The internal storage of
File
objects inside aFiles
object has been reworked, so any plugins that choose to accessFiles._files
will get a deprecation warning.The order of
File
objects inside aFiles
collection is no longer significant when automatically inferring thenav
. They get forcibly sorted according to the default alphabetic order.Context: #3451, #3463
Hooks and debugging
Hook files can now import adjacent *.py files using the
import
statement. Previously this was possible to achieve only through asys.path
workaround. See the new mention in documentation. Context: #3568Verbose
-v
log shows the sequence of plugin events in more detail - shows each invoked plugin one by one, not only the event type. Context: #3444Deprecations
Python 3.7 is no longer supported, Python 3.12 is officially supported. Context: #3429
The theme config file
mkdocs_theme.yml
no longer executes YAML tags. Context: #3465The plugin event
on_page_read_source
is soft-deprecated because there is always a better alternative to it (see the newFile
API or juston_page_markdown
, depending on the desired interaction).When multiple plugins/hooks apply this event handler, they trample over each other, so now there is a warning in that case.
See documentation. Context: #3503
API deprecations
It is no longer allowed to set
File.page
to a type other thanPage
or a subclass thereof. Context: #3443 - following the deprecation in version 1.5.3 and #3381.Theme._vars
is deprecated - usetheme['foo']
instead oftheme._vars['foo']
utils
:modified_time()
,get_html_path()
,get_url_path()
,is_html_file()
,is_template_file()
are removed.path_to_url()
is deprecated.LiveReloadServer.watch()
no longer accepts a custom callback.Context: #3429
Misc
sitemap.xml.gz
file is slightly more reproducible and no longer changes on every build, but instead only once per day (upon a date change). Context: #3460Other small improvements; see commit log.
mondeja/mkdocs-include-markdown-plugin (mkdocs-include-markdown-plugin)
v7.1.2
Compare Source
Enhancements
cache_dir
global setting to configure the path to the cache directory. When setted avoids the requirement to installplatformdirs
to use HTTP caching.v7.1.1
Compare Source
New features
directives
global setting to customize directive names (#241)Enhancements
v7.0.1
Compare Source
Enhancements
v7.0.0
Compare Source
Breaking changes
No longer installable on Python v3.8
Minimum Python version for installation is v3.9. Python v3.8 reached his end of life at 2024-10-07.
Comments are turned off by default
Before this release, the default value for
comments
argument ofinclude-markdown
directive wastrue
. Now has been switched tofalse
. This prevents some inconvenients, for example, trying to include one-line texts on table cells and list items.If you want the previous behaviour, configure
comments
astrue
in the global configuration:Indented code blocks must be surrounded by newlines
Now mkdocs-include-markdown-plugin will only detect indented code blocks if are surrounded by newlines, conforming to CommonMark specification.
In the practice this means that you must surround indented code blocks with newlines or possible link targets URLs will be rewritten to work in relative files. For example, the next code is not treated as an indented code block any more and will break:
v6.2.2
Compare Source
Enhancements
wcmatch
dependency.v6.2.1
Compare Source
Bug fixes
v6.2.0
Compare Source
New features
recursive
argument toinclude-markdown
directive.Enhancements
comments
ininclude
directives (include
does not provides acomments
argument).v6.1.1
Compare Source
Enhancements
include
directive in the same file with otherinclude-markdown
directive.v6.1.0
Compare Source
New features
recursive
argument to theinclude
directive that allows to stop recursively processing includes in included files.v6.0.7
Compare Source
Bug fixes
docs_dir
directory is not found.v6.0.6
Compare Source
Bug fixes
v6.0.5
Compare Source
Bug fixes
heading_offset
not being applied.squidfunk/mkdocs-material (mkdocs-material)
v9.5.49
: mkdocs-material-9.5.49Compare Source
v9.5.48
: mkdocs-material-9.5.48Compare Source
v9.5.47
: mkdocs-material-9.5.47Compare Source
Thanks go to @perpil for their contributions
v9.5.46
: mkdocs-material-9.5.46Compare Source
preload
hints in privacy pluginThanks go to @nejch and @perpil for their contributions
v9.5.45
: mkdocs-material-9.5.45Compare Source
Thanks go to @FrancoisCapon and @perpil for their contributions
v9.5.44
: mkdocs-material-9.5.44Compare Source
Thanks go to @nejch for their contributions.
v9.5.43
: mkdocs-material-9.5.43Compare Source
Thanks go to @nejch for their contributions
v9.5.42
: mkdocs-material-9.5.42Compare Source
v9.5.41
: mkdocs-material-9.5.41Compare Source
v9.5.40
: mkdocs-material-9.5.40Compare Source
Thanks go to @pekkaklarck and @klejejs for their contributions
v9.5.39
: mkdocs-material-9.5.39Compare Source
Thanks go to @ilyagr for their contributions
v9.5.38
: mkdocs-material-9.5.38Compare Source
Thanks go to @gerardkraja for their contributions
v9.5.37
: mkdocs-material-9.5.37Compare Source
v9.5.36
: mkdocs-material-9.5.36Compare Source
v9.5.35
: mkdocs-material-9.5.35Compare Source
v9.5.34
: mkdocs-material-9.5.34Compare Source
Thanks go to @manselmi for their contributions
v9.5.33
: mkdocs-material-9.5.33Compare Source
v9.5.32
: mkdocs-material-9.5.32Compare Source
Thanks go to @joaopalmeiro for their contributions
v9.5.31
: mkdocs-material-9.5.31Compare Source
v9.5.30
: mkdocs-material-9.5.30Compare Source
Thanks go to @sisp for their contributions
v9.5.29
: mkdocs-material-9.5.29Compare Source
Thanks go to @mmontes11 for their contributions
v9.5.28
: mkdocs-material-9.5.28Compare Source
v9.5.27
: mkdocs-material-9.5.27Compare Source
Thanks to @Eilyre for their contributions
v9.5.26
: mkdocs-material-9.5.26Compare Source
v9.5.25
: mkdocs-material-9.5.25Compare Source
v9.5.24
: mkdocs-material-9.5.24Compare Source
v9.5.23
: mkdocs-material-9.5.23Compare Source
v9.5.22
: mkdocs-material-9.5.22Compare Source
v9.5.21
: mkdocs-material-9.5.21Compare Source
Thanks to @kamilkrzyskow for their contributions
v9.5.20
: mkdocs-material-9.5.20Compare Source
v9.5.19
: mkdocs-material-9.5.19Compare Source
setup.py
, now that GitHub fully understandspyproject.toml
v9.5.18
: mkdocs-material-9.5.18Compare Source
v9.5.17
: mkdocs-material-9.5.17Compare Source
Thanks to @stcksmsh for their contributions.
v9.5.16
: mkdocs-material-9.5.16Compare Source
Thanks to @kamilkrzyskow, @Guts, @szg-alex-payne and @natakazakova for their contributions
v9.5.15
: mkdocs-material-9.5.15Compare Source
v9.5.14
: mkdocs-material-9.5.14Compare Source
Thanks to @kamilkrzyskow, @yubiuser and @todeveni for their contributions
v9.5.13
: mkdocs-material-9.5.13Compare Source
Thanks to @kamilkrzyskow and @scepka for their contributions
v9.5.12
: mkdocs-material-9.5.12Compare Source
v9.5.11
: mkdocs-material-9.5.11Compare Source
v9.5.10
: mkdocs-material-9.5.10Compare Source
v9.5.9
: mkdocs-material-9.5.9Compare Source
v9.5.8
: mkdocs-material-9.5.8Compare Source
v9.5.7
: mkdocs-material-9.5.7Compare Source
v9.5.6
: mkdocs-material-9.5.6Compare Source
v9.5.5
: mkdocs-material-9.5.5Compare Source
onclick
handlersv9.5.4
: mkdocs-material-9.5.4Compare Source
ncipollo/release-action (ncipollo/release-action)
v1.14.0
Compare Source
What's Changed
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR was generated by Mend Renovate. View the repository job log.