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).
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).
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/master
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
The generated docs now show the symbol type in the table of contents.
The dependecies were updated to the latest versions.
Disabled some pylint checks that are already checked by other tools.
The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.
Bug Fixes
The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.
Cookiecutter template
Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
Make the nox-cross-arch-all job fail if any nox-cross-arch matrix job fails.
Fix credentials not being passed to the test-installation job in the CI workflow.
This release includes quite a few enhancements and bug fixes for the cookiecutter template, but most importantly a new script for migrating to new templates, generating the templates is no longer needed for upgrading.
Upgrading
Cookiecutter template
A new script for migrating to new templates (instead of regenerating all files) is provided. It can't handle the upgrade 100% automatically, but should make the migration process much easier and less error prone.
To run it, the simplest way is to fetch it from GitHub and run it directly:
curl -sSL https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/v0.10.0/cookiecutter/migrate.sh | sh
Make sure the version you want to migrate to is correct in the URL.
For jumping multiple versions you should run the script multiple times, once for each version.
And remember to follow any manual instructions for each run.
New Features
A new GitHub ruleset is provided to configure the merge queue, so branch protection rules are not needed anymore.
Enhancements
The generated docs now show the symbol type in the table of contents.
Cookiecutter template
The Markdown dependency was bumped so we don't need to add a type: ignore due to incorrect type hints.
The generated docs now show the symbol type in the table of contents.
The dependecies were updated to the latest versions.
Disabled some pylint checks that are already checked by other tools.
The generated documentation now uses symlinks for aliases, which allows deep linking when using aliases too.
Bug Fixes
The code example extractor relied on a bug in the upstream sybil project that was recently fixed, thus our code also needed to be fixed.
Cookiecutter template
Fixed a bug where the pip cache post action fails in the CI workflow because of permissions issues.
Make the nox-cross-arch-all job fail if any nox-cross-arch matrix job fails.
Fix credentials not being passed to the test-installation job in the CI workflow.
Make sure credentials are configured for all jobs that check out the repository in the CI workflow.
... (truncated)
Commits
bfd45a8 Add pull-requests read permission to the release-notes-check workflow (#289)
We’ve just uploaded mypy 1.11 to the Python Package Index (PyPI). Mypy is a static type checker for Python. This release includes new features, performance improvements and bug fixes. You can install it as follows:
python3 -m pip install -U mypy
You can read the full documentation for this release on Read the Docs.
Support Python 3.12 Syntax for Generics (PEP 695)
Mypy now supports the new type parameter syntax introduced in Python 3.12 (PEP 695).
This feature is still experimental and must be enabled with the --enable-incomplete-feature=NewGenericSyntax flag, or with enable_incomplete_feature = NewGenericSyntax in the mypy configuration file.
We plan to enable this by default in the next mypy feature release.
This example demonstrates the new syntax:
# Generic function
def f[T](https://github.com/python/mypy/blob/master/x: T) -> T: ...
reveal_type(f(1)) # Revealed type is 'int'
Generic class
class C[T]:
def init(self, x: T) -> None:
self.x = x
c = C('a')
reveal_type(c.x) # Revealed type is 'str'
Type alias
type A[T] = C[list[T]]
This feature was contributed by Jukka Lehtosalo.
Support for functools.partial
Mypy now type checks uses of functools.partial. Previously mypy would accept arbitrary arguments.
Bumps the required group with 18 updates in the / directory:
7.1.0
7.1.1
0.5.3
0.5.9
24.4.2
24.8.0
3.6.0
3.7
2.1.2
2.1.3
1.0.5
1.2.0
9.5.27
9.5.39
0.25.1
0.26.1
1.10.5
1.11.1
0.9.2
0.10.0
1.10.1
1.11.2
3.6.0.20240316
3.7.0.20240822
8.2.2
8.3.3
3.2.5
3.3.1
0.9.2
0.10.0
0.23.7
0.24.0
0.6
0.7
6.104.2
6.112.2
Updates
flake8
from 7.1.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 documentationUpdates
pydoclint
from 0.5.3 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
markdown
from 3.6.0 to 3.7Release notes
Sourced from markdown's releases.
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 documentationUpdates
mike
from 2.1.2 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.dev0Updates
mkdocs-macros-plugin
from 1.0.5 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.5.27 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.1 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: Formatc6ca522
docs: Fix dead link8041ef3
docs: Update code highlight linesUpdates
mkdocstrings-python
from 1.10.5 to 1.11.1Release notes
Sourced from mkdocstrings-python's releases.
... (truncated)
Changelog
Sourced from mkdocstrings-python's changelog.
... (truncated)
Commits
6dafa9a
chore: Prepare release 1.11.1dd8b014
refactor: Preparerelative_crossrefs
andscoped_crossrefs
insiders features7b11ba8
docs: Update docs from insiders446d725
chore: Prepare release 1.11.0bb4be5b
feat: Hook into autorefs to provide context around cross-ref errors2d59cdb
chore: Prepare release 1.10.968cb72f
refactor: Use new autorefs syntax2299ab5
build: Explicitly depend on mkdocs-autorefs to be able to specify lower bound81d698e
chore: Clean up check dutya541b5b
chore: Prepare release 1.10.8Updates
frequenz-repo-config[lib]
from 0.9.2 to 0.10.0Release notes
Sourced from frequenz-repo-config[lib]'s releases.
... (truncated)
Changelog
Sourced from frequenz-repo-config[lib]'s changelog.
... (truncated)
Commits
bfd45a8
Add pull-requests read permission to the release-notes-check workflow (#289)6aa6bc0
Prepare for the v0.10.0 release (#290)297b184
Update version in the template pyproject.toml632283d
Prepare the release notes for v0.10.0 release1778ff8
Add pull-requests read permission to the release-notes-check workflow2ac253a
Disable the newcheck-class-attributes
check in pydoclint 0.5.3 (#288)1660756
Disable the newcheck-class-attributes
check in pydoclint 0.5.3327879b
Fix credentials not passed or configured the CI workflow (#286)6195bc7
Update release notesbef233c
Remove the TODOs from the migrationUpdates
mypy
from 1.10.1 to 1.11.2Changelog
Sourced from mypy's changelog.
... (truncated)
Commits
789f02c
Bump version to 1.11.2917cc75
An alternative fix for a union-like literal string (#17639)7d805b3
Unwrap TypedDict item types before storing (#17640)32675dd
Revert "Fix Literal strings containing pipe characters" (#17638)778542b
Revert "FixRawExpressionType.accept
crash with--cache-fine-grained
" (#1...14ab742
Bump version to 1.11.2+dev570b90a
Bump version to 1.11b3a102e
FixRawExpressionType.accept
crash with--cache-fine-grained
(#17588)aec04c7
Fix PEP 604 isinstance caching (#17563)cb44e... _Description has been truncated_