A new AbbrTreeprocessor has been introduced, which replaces the now deprecated
AbbrInlineProcessor. Abbreviation processing now happens after Attribute Lists,
avoiding a conflict between the two extensions (#1460).
The AbbrPreprocessor class has been renamed to AbbrBlockprocessor, which
better reflects what it is. AbbrPreprocessor has been deprecated.
A call to Markdown.reset() now clears all previously defined abbreviations.
Abbreviations are now sorted by length before executing AbbrTreeprocessor
to ensure that multi-word abbreviations are implemented even if an abbreviation
exists for one of those component words. (#1465)
Abbreviations without a definition are now ignored. This avoids applying
abbr tags to text without a title value.
Added an optional glossary configuration option to the abbreviations extension.
This provides a simple and efficient way to apply a dictionary of abbreviations
to every page.
Abbreviations can now be disabled by setting their definition to "" or ''.
This can be useful when using the glossary option.
Fixed
Fixed links to source code on GitHub from the documentation (#1453).
Release 3.6
Changed
Refactor TOC Sanitation
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that
A new AbbrTreeprocessor has been introduced, which replaces the now deprecated
AbbrInlineProcessor. Abbreviation processing now happens after Attribute Lists,
avoiding a conflict between the two extensions (#1460).
The AbbrPreprocessor class has been renamed to AbbrBlockprocessor, which
better reflects what it is. AbbrPreprocessor has been deprecated.
A call to Markdown.reset() now clears all previously defined abbreviations.
Abbreviations are now sorted by length before executing AbbrTreeprocessor
to ensure that multi-word abbreviations are implemented even if an abbreviation
exists for one of those component words. (#1465)
Abbreviations without a definition are now ignored. This avoids applying
abbr tags to text without a title value.
Added an optional glossary configuration option to the abbreviations extension.
This provides a simple and efficient way to apply a dictionary of abbreviations
to every page.
Abbreviations can now be disabled by setting their definition to "" or ''.
This can be useful when using the glossary option.
Fixed
Fixed links to source code on GitHub from the documentation (#1453).
[3.6] -- 2024-03-14
Changed
Refactor TOC Sanitation
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
Added: three hooks register_variables/macros/filters to facilitate
cooperation with other MkDocs plugins.
Fixed: `define_env() was always required in module (#191)
Added: trace the case when no module is found (INFO)
Improved documentation, particularly about HTML pages
Added: parameters j2_comment_start_string and
j2_comment_end_string to plugin's parameters,
to specify alternate markers for comments.
Added the multiline parameter force_render_paths in the config file,
to specify directories or file patterns to be rendered for the case when render_by_default = false
(the render_macros parameter in the YAML header of the page
has the last word).
Bumps the required group with 15 updates in the / directory:
7.0.0
7.1.1
0.3.2
0.5.9
24.4.2
24.8.0
5.12.0
5.13.2
3.4.4
3.7
2.0.0
2.1.3
1.0.4
1.2.0
9.4.4
9.5.39
0.25.0
0.26.1
1.10.8
1.11.1
0.9.2
0.10.0
1.5.1
1.11.2
3.4.2.10
3.7.0.20240822
3.0.2
3.3.1
0.9.2
0.10.0
Updates
flake8
from 7.0.0 to 7.1.1Commits
cf1542c
Release 7.1.1939ea3d
Merge pull request #1949 from stephenfin/issue-1948bdcd5c2
Handle escaped braces in f-strings2a811cc
Merge pull request #1946 from Viicos/patch-110314ad
Fix wording of plugins documentation65a38c4
Release 7.1.034c97e0
Merge pull request #1939 from PyCQA/new-pycodestyledefd315
latest pycodestyle408d4d6
Merge pull request #1930 from mzagol/patch-1866ad72
Add --extend-exclude to the TOCUpdates
pydoclint
from 0.3.2 to 0.5.9Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
8170436
Improve handling of long type annotations (#173)27ff769
doc(usage): Including a null-ls use with neovim. (#167)5e941f5
fix: DOC503 catch namespaced exceptions (#168)f758604
feat: introduce DOC503 for checking specific raised exceptions (#161)ae28589
Switch from tab to 4 spaces in baseline (#152)1e80fd3
tox: usedeps = .
instead ofpip install
(#160)23b89f6
docs: add "sphinx" as an allowed style (#159)94efc5f
Stop trying to check folder with names ending in.py
(#155)0247ef5
Improve class attr comparison logic (#154)0b750d5
Add option to treat property methods as class attributes (#153)Updates
black
from 24.4.2 to 24.8.0Release notes
Sourced from black's releases.
Changelog
Sourced from black's changelog.
Commits
b965c2a
Prepare release 24.8.0 (#4426)9ccf279
Documentfind_project_root
ignoringpyproject.toml
without[tool.black]
...14b6e61
fix: Enhace black efficiently to skip directories listed in .gitignore (#4415)b1c4dd9
fix: respect braces better in f-string parsing (#4422)4b4ae43
Fix incorrect linenos on fstring tokens with escaped newlines (#4423)7fa1faf
docs: fix the installation command of extra for blackd (#4413)8827acc
Bump sphinx from 7.3.7 to 7.4.0 in /docs (#4404)b0da11d
Bump furo from 2024.5.6 to 2024.7.18 in /docs (#4409)721dff5
fix: avoid formatting backslash strings inside f-strings (#4401)7e2afc9
Updateactions/checkout
to v4 to stop node deprecation warnings (#4379)Updates
isort
from 5.12.0 to 5.13.2Release notes
Sourced from isort's releases.
... (truncated)
Changelog
Sourced from isort's changelog.
Commits
c655831
Merge pull request #2214 from PyCQA/version/5.13.2b4335b4
Prepare version 5.13.2c36e43c
Merge pull request #2184 from bp72/issue/2154e38702f
Merge pull request #2213 from davidculley/confine-precommit-to-stagesee8d87f
Add fix for the error found by hypothesis5849ec2
Apply the bracket fix from issue 471 only for use_parentheses=Truedf0e119
confine pre-commit to stages9255bca
Merge pull request #2212 from PyCQA/bugfix/#2211-colors-extra5336d7d
Fix colors extras643d9c4
Merge pull request #2210 from PyCQA/version/5.13.1Updates
markdown
from 3.4.4 to 3.7Release notes
Sourced from markdown's releases.
... (truncated)
Changelog
Sourced from markdown's changelog.
... (truncated)
Commits
da03cd6
Bump version to 3.7bd836a1
Update griffe_extensions to support Griffe v 1.0.33359fa
Abbr Extension: Definition Sorting and Glossary storageec8c305
Refactorabbr
Extension993b57b
Fixed links to source code on GitHub from the documentatione524b8f
Bump version to 3.63d8afc6
Allow attr_list quoted values to contain curly braces9edba85
Refactor abbr escapinge4ab4a6
Refactor TOC sanitationa18765c
Explicitly omit carot and backslash from abbrUpdates
mike
from 2.0.0 to 2.1.3Release notes
Sourced from mike's releases.
Changelog
Sourced from mike's changelog.
Commits
c4e9608
Update version to 2.1.33b19e27
Announce the previous changedd9826a
Consult deploy prefix when deleting files during deploy; resolves #22791cf5ee
Properly escape parameters in regex90cf131
Update version to 2.2.0.dev062aaeaf
Update version to 2.1.23f7d756
Use "--" to disambiguate Git arguments in a few more places; resolves #2185e6970d
Belatedly update copyright year9291efb
Update version to 2.2.0.dev00bdfe24
Update version to 2.1.1Updates
mkdocs-macros-plugin
from 1.0.4 to 1.2.0Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
e8b3f45
Document hooks for #237 (register macros/variables/filters)c1029d5
Document how to correct issue with macros / admonitions (#240)67ccb15
Merge pull request #238 from timvink/master03f5e89
Fix registration systemddace97
remove property on register methods363d904
Add three hooksregister_variables/macros/filters
(#237)2fb833e
Improved implementation for relative url (#236)69e7cad
Merge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master5bec964
Add standard filternormalize_url
(#236)9a08f11
Merge pull request #228 from caomingpei/masterUpdates
mkdocs-material
from 9.4.4 to 9.5.39Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
70db88f
Prepare 9.5.39 release187705e
Updated dependencies56fdb28
Adjusted code copy button documentationaeb9492
Fixed stay no page functionality when using mike's canonical versioning (#7559)50a15be
Updated link to step-by-step guide on YouTube117250a
Prepare 9.5.38 release74ca234
Added Albanian translations84ddbba
Prepare 9.5.37 releasefd98413
Documentation (#7557)573d23d
Updated dependenciesUpdates
mkdocstrings[python]
from 0.25.0 to 0.26.1Release notes
Sourced from mkdocstrings[python]'s releases.
Changelog
Sourced from mkdocstrings[python]'s changelog.
Commits
651d176
chore: Prepare release 0.26.1db2ab34
fix: Instantiate config of the autorefs plugin when it is not enabled by the ...a65035a
docs: Clarify that Installation sectionb1aa042
chore: Prepare release 0.26.0b63e726
feat: Allow hooking into autorefs when converting Markdown docstrings3c878b7
chore: Upgrade mkdocs-redirects lower bound to avoid deprecation warning28565f9
build: Upgrade Python-Markdown lower bound to 3.652fad11
style: FormatLooks like these dependencies are updatable in another way, so this is no longer needed.