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)
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 in /.config with 14 updates:
1.5.31.6.00.24.10.24.32.16.12.18.10.41.30.44.03.63.73.5.23.61.8.01.8.11.2.01.2.19.5.139.5.181.8.01.10.010.2.010.3.02.212.2210.7.110.82023.12.252024.4.16Updates
mkdocsfrom 1.5.3 to 1.6.0Release notes
Sourced from mkdocs's releases.
... (truncated)
Commits
0998fecRelease 1.6.0 (#3631)bce85bfFix for showing repository icon even when a file has no edit_uri (#3657)0ac05daRe-generate localization files (#3634)6244500Remove jQuery frommkdocstheme (#3649)f85d429Prevent a flash of white color when dark mode is enabled (#3647)e39cce2Fix style of modal close button (#3651)652813dPrevent a crash if stdin is not defined (#3609)59a295fMerge pull request #3493 from waylan/22486f5e748Merge pull request #3625 from mkdocs/themepo1451fb3Babel setuptools frontend is still used in the install hookUpdates
mkdocstringsfrom 0.24.1 to 0.24.3Release notes
Sourced from mkdocstrings's releases.
Changelog
Sourced from mkdocstrings's changelog.
Commits
828bd59chore: Prepare release 0.24.37fe3e5ffix: Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...)7b9827cchore: Prepare release 0.24.217bfc87chore: Use PEP 440 versioning scheme for changelog024ac41ci: Ignore mypy warningc0d0090fix: Support HTML toc labels with Python-Markdown 3.6+ccbbbf1chore: Template upgrade56cf7d5docs: List VBA handler9e1bf62docs: Fix link to Griffe extensionf071d5dchore: Switch to Copier UV templateUpdates
pipdeptreefrom 2.16.1 to 2.18.1Release notes
Sourced from pipdeptree's releases.
Commits
6d4d4a7Fix test_console failure finding pipdeptree in other environments (#351)bf5a865Modify tests to ensure $PYTHONPATH is given to the custom interpreter (#353)25cbb6frefactor the non_host part for not injecting to custom env (#346)268dee8[pre-commit.ci] pre-commit autoupdate (#347)7a6e0ffHandle invalid requirement strings when using importlib.metadata (#345)ff31dc4Handle duplicated package metadata when using importlib.metadata (#342)91d21e3replace pkg_resources with importlib.metadata and packaging (#333)edf33d9[pre-commit.ci] pre-commit autoupdate (#338)e1d3da4Use GitHub issue forms (#337)3e1a8ffList pip as dependency (#336)Updates
griffefrom 0.41.3 to 0.44.0Release notes
Sourced from griffe's releases.
... (truncated)
Changelog
Sourced from griffe's changelog.
... (truncated)
Commits
325641fchore: Prepare release 0.44.06f22256fix: Fix enumeration properties on expression names9b5ca45feat: Addresolvedproperty on expression names, returning the correspondin...20ff7b6chore: Cleanup505d738chore: Prepare release 0.43.0d6a64d8Merge branch 'enum-values'fdb21d9feat: Add properties telling whether an expression name resolves to an enumer...373bb08chore: Prepare release 0.42.2ee27ad9fix: Fix target path of aliases for multipart imports (import a.b.c as x)01da648chore: Prepare release 0.42.1Updates
idnafrom 3.6 to 3.7Release notes
Sourced from idna's releases.
Changelog
Sourced from idna's changelog.
Commits
1d365e1Release v3.7c1b3154Merge pull request #172 from kjd/optimize-contextj0394ec7Merge branch 'master' into optimize-contextjcd58a23Merge pull request #152 from elliotwutingfeng/dev5beb28bMore efficient resolution of joiner contexts1b12148Update ossf/scorecard-action to v2.3.1d516b87Update Github actions/checkout to v4c095c75Merge branch 'master' into dev60a0a4cFix typo in GitHub Actions workflow key5918a0eMerge branch 'master' into devUpdates
markdownfrom 3.5.2 to 3.6Release notes
Sourced from markdown's releases.
Changelog
Sourced from markdown's changelog.
Commits
e524b8fBump version to 3.63d8afc6Allow attr_list quoted values to contain curly braces9edba85Refactor abbr escapinge4ab4a6Refactor TOC sanitationa18765cExplicitly omit carot and backslash from abbr421f1e8Give smarty tree processor higher priority than tocc334a3eEnsure lines after heading in loose list are properly detabbedea92856Update the license template so GitHub can detect ita2effd6Disable mkdocstrings show_symbol_type_toc option to work around searching iss...91f9a12Restore Attribute symbol type in mkdocstrings templateUpdates
markdown-execfrom 1.8.0 to 1.8.1Release notes
Sourced from markdown-exec's releases.
Changelog
Sourced from markdown-exec's changelog.
Commits
bde280fchore: Prepare release 1.8.151493f2fix: Add missing CSS class to the ANSI stylesheet681c4e2docs: Stop using PDM command in examples1de6612docs: Show real sources in gallerydaba198chore: Switch to Copier UV templateb9f0e95chore: Template upgradeUpdates
mkdocs-htmlproofer-pluginfrom 1.2.0 to 1.2.1Release notes
Sourced from mkdocs-htmlproofer-plugin's releases.
Commits
214a0b3Release 1.2.1577f2f7Fix checking image link (#82)d9fd2ceRework use_directory_url=True validation to better catch incorrect links (#80)ac22c24Bump up version to 1.3.0.devUpdates
mkdocs-materialfrom 9.5.13 to 9.5.18Release notes
Sourced from mkdocs-material's releases.
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
3b592abPrepare 9.5.18 releasef028004Merge pull request #7045 from squidfunk/refactor/tooltip-positioning29658edMerge branch 'master' into refactor/tooltip-positioning851e5bbFixed rendering glitch when hovering contributor avatar599193eFixed overly long tooltipse15518cRefactored tooltips4eb1a43Added missing CSS for highlight fix5707773Updated dependencies9d33f8aFixed highlighted lines in code blocks being cutoff on mobilecd08611Updated dependenciesUpdates
mkdocstrings-pythonfrom 1.8.0 to 1.10.0Release notes
Sourced from mkdocstrings-python's releases.
... (truncated)
Changelog
Sourced from mkdocstrings-python's changelog.
Commits
98e9796chore: Prepare release 1.10.011d81d8fix: Render enumeration instance name instead of just "value", allowing prope...9f8456adocs: Improve docs about CSS customizationd6e1d68feat: Add CSS classesdoc-section-titleanddoc-section-itemin docstring...0a2e917chore: Prepare release 1.9.20c1e2c1deps: Remove cap on Python-Markdown 3.6 now that ToC labels are fixed by mkdo...d3b05adchore: Prepare release 1.9.1bd73497fix: Don't try loading packages from relative paths3cf7055docs: Fix link to Griffe extension in insiders pageLooks like these dependencies are updatable in another way, so this is no longer needed.