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: #3391
New 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
[!warning]
Changed from version 1.5:
The exclude_docs config was split up into two separate concepts.
The exclude_docs config no longer has any special behavior for mkdocs 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 key draft_docs.
Reduce warning levels when a "draft" page has a link to a non-existent file. Context: #3449
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.
Built-in themes now also support Polish language (#3613)
"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)
[#221](https://github.com/Kozea/cairocffi/issues/221) <https://github.com/Kozea/cairocffi/pull/225>_:
Add environment variable to set folder where DLLs are installed on Windows
[#225](https://github.com/Kozea/cairocffi/issues/225) <https://github.com/Kozea/cairocffi/pull/225>_:
Use Ruff instead of Flake8 and isort
Version 1.6.1
.............
Released on 2023-07-24
[#217](https://github.com/Kozea/cairocffi/issues/217) <https://github.com/Kozea/cairocffi/issues/217>_:
Repair installation with PyInstaller
Version 1.6.0
.............
Released on 2023-06-12
This version uses a new CFFI mode that may break your program.
CairoCFFI now uses Flit for packaging and is also distributed as a Python
wheel.
Please test carefully and don’t hesitate to report issues before using it in
production.
[#216](https://github.com/Kozea/cairocffi/issues/216) <https://github.com/Kozea/cairocffi/pull/216>_:
Use ABI-level in-line CFFI mode
Version 1.5.1
.............
Released on 2023-04-15
[#212](https://github.com/Kozea/cairocffi/issues/212) <https://github.com/Kozea/cairocffi/issues/212>_:
Bring back XCB support during wheel generation
Add properties telling whether an expression name resolves to an enumeration class, instance or value (fdb21d9 by Timothée Mazzucotelli). Issue-mkdocstrings/python#124
Add properties telling whether an expression name resolves to an enumeration class, instance or value (fdb21d9 by Timothée Mazzucotelli). Issue-mkdocstrings/python#124
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
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
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
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
Bumps the dependencies group with 17 updates in the /.config directory:
1.5.3
1.6.0
0.24.1
0.25.0
2.16.1
2.18.1
1.6.1
1.7.0
0.41.3
0.44.0
3.6
3.7
3.5.2
3.6
1.8.0
1.8.1
1.2.0
1.2.1
9.5.13
9.5.19
1.8.0
1.10.0
10.2.0
10.3.0
4.2.0
4.2.1
2.21
2.22
10.7.1
10.8.1
2023.12.25
2024.4.16
1.2.1
1.3.0
Updates
mkdocs
from 1.5.3 to 1.6.0Release notes
Sourced from mkdocs's releases.
... (truncated)
Commits
0998fec
Release 1.6.0 (#3631)bce85bf
Fix for showing repository icon even when a file has no edit_uri (#3657)0ac05da
Re-generate localization files (#3634)6244500
Remove jQuery frommkdocs
theme (#3649)f85d429
Prevent a flash of white color when dark mode is enabled (#3647)e39cce2
Fix style of modal close button (#3651)652813d
Prevent a crash if stdin is not defined (#3609)59a295f
Merge pull request #3493 from waylan/22486f5e748
Merge pull request #3625 from mkdocs/themepo1451fb3
Babel setuptools frontend is still used in the install hookUpdates
mkdocstrings
from 0.24.1 to 0.25.0Release notes
Sourced from mkdocstrings's releases.
Changelog
Sourced from mkdocstrings's changelog.
Commits
87d8229
chore: Prepare release 0.25.0c5b5f69
refactor: Allow specifying name of template loggers7ff1681
docs: Enable parameter headings253d215
docs: Load inventories for MkDocs and Markdown1532b59
feat: Supportonce
parameter in logging methods, allowing to log a message ...d799d2f
feat: Support blank line between::: path
and YAML options828bd59
chore: Prepare release 0.24.37fe3e5f
fix: Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...)7b9827c
chore: Prepare release 0.24.217bfc87
chore: Use PEP 440 versioning scheme for changelogUpdates
pipdeptree
from 2.16.1 to 2.18.1Release notes
Sourced from pipdeptree's releases.
Commits
6d4d4a7
Fix test_console failure finding pipdeptree in other environments (#351)bf5a865
Modify tests to ensure $PYTHONPATH is given to the custom interpreter (#353)25cbb6f
refactor the non_host part for not injecting to custom env (#346)268dee8
[pre-commit.ci] pre-commit autoupdate (#347)7a6e0ff
Handle invalid requirement strings when using importlib.metadata (#345)ff31dc4
Handle duplicated package metadata when using importlib.metadata (#342)91d21e3
replace pkg_resources with importlib.metadata and packaging (#333)edf33d9
[pre-commit.ci] pre-commit autoupdate (#338)e1d3da4
Use GitHub issue forms (#337)3e1a8ff
List pip as dependency (#336)Updates
cairocffi
from 1.6.1 to 1.7.0Changelog
Sourced from cairocffi's changelog.
... (truncated)
Commits
4bafdd7
Version 1.7.0a535d50
Merge pull request #225 from Kozea/ruffaa240d3
Use ruff instead of flake8 and isort33501f0
Fix CI tests on macOSee7186b
Drop Python 3.7, support Python 3.12dbb62b0
Clean and fix tests8a8d35a
Update tests on GitHub Actions290b5db
Merge pull request #221 from Li-Xiang-Ideal/patch-13e3dafd
Add missing importf4ebc6e
Add documentation about CAIROCFFI_DLL_DIRECTORIESUpdates
griffe
from 0.41.3 to 0.44.0Release notes
Sourced from griffe's releases.
... (truncated)
Changelog
Sourced from griffe's changelog.
... (truncated)
Commits
325641f
chore: Prepare release 0.44.06f22256
fix: Fix enumeration properties on expression names9b5ca45
feat: Addresolved
property on expression names, returning the correspondin...20ff7b6
chore: Cleanup505d738
chore: Prepare release 0.43.0d6a64d8
Merge branch 'enum-values'fdb21d9
feat: Add properties telling whether an expression name resolves to an enumer...373bb08
chore: Prepare release 0.42.2ee27ad9
fix: Fix target path of aliases for multipart imports (import a.b.c as x
)01da648
chore: Prepare release 0.42.1Updates
idna
from 3.6 to 3.7Release notes
Sourced from idna's releases.
Changelog
Sourced from idna's changelog.
Commits
1d365e1
Release v3.7c1b3154
Merge pull request #172 from kjd/optimize-contextj0394ec7
Merge branch 'master' into optimize-contextjcd58a23
Merge pull request #152 from elliotwutingfeng/dev5beb28b
More efficient resolution of joiner contexts1b12148
Update ossf/scorecard-action to v2.3.1d516b87
Update Github actions/checkout to v4c095c75
Merge branch 'master' into dev60a0a4c
Fix typo in GitHub Actions workflow key5918a0e
Merge branch 'master' into devUpdates
markdown
from 3.5.2 to 3.6Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
e524b8f
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 abbr421f1e8
Give smarty tree processor higher priority than tocc334a3e
Ensure lines after heading in loose list are properly detabbedea92856
Update the license template so GitHub can detect ita2effd6
Disable mkdocstrings show_symbol_type_toc option to work around searching iss...91f9a12
Restore Attribute symbol type in mkdocstrings templateUpdates
markdown-exec
from 1.8.0 to 1.8.1Release notes
Sourced from markdown-exec's releases.
Changelog
Sourced from markdown-exec's changelog.
Commits
bde280f
chore: Prepare release 1.8.151493f2
fix: Add missing CSS class to the ANSI stylesheet681c4e2
docs: Stop using PDM command in examples1de6612
docs: Show real sources in gallerydaba198
chore: Switch to Copier UV templateb9f0e95
chore: Template upgradeUpdates
mkdocs-htmlproofer-plugin
from 1.2.0 to 1.2.1Release notes
Sourced from mkdocs-htmlproofer-plugin's releases.
Commits
214a0b3
Release 1.2.1577f2f7
Fix checking image link (#82)d9fd2ce
Rework use_directory_url=True validation to better catch incorrect links (#80)ac22c24
Bump up version to 1.3.0.devUpdates
mkdocs-material
from 9.5.13 to 9.5.19Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
0a39f04
Prepare 9.5.19 release023e177
Merge pull request #7082 from squidfunk/chore/update-to-mkdocs-1.62585b82
Fixed all anchors after turning on validation0203408
Merge branch 'master' into chore/update-to-mkdocs-1.62d07a6a
Fixed rendering of tab indicator of nested content tabsd98243d
Merge branch 'master' into chore/update-to-mkdocs-1.6374bbab
Updated dependencies254ee97
Updated distribution files04f177c
Improved resilience of tags plugin (#7098)bde889f
Fixed Japanese translationsUpdates
mkdocstrings-python
from 1.8.0 to 1.10.0Release notes
Sourced from mkdocstrings-python's releases.
Looks like these dependencies are updatable in another way, so this is no longer needed.