From 76e8dcc8b195eac09433b8ede65ccfee354c7f14 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:08:51 +0100 Subject: [PATCH 1/5] Release notes for ProperDocs 1.6.5 --- docs/about/release-notes.md | 32 +++++++++++++++++-- .../properdocs_theme_mkdocs/__init__.py | 2 +- .../properdocs_theme_readthedocs/__init__.py | 2 +- properdocs/__init__.py | 2 +- properdocs/replacement_warning.py | 2 +- 5 files changed, 33 insertions(+), 7 deletions(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index e515d322..1f950a60 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -14,12 +14,36 @@ You can determine your currently installed version using `properdocs --version`: ```console $ properdocs --version -properdocs, version 1.5.0 from /path/to/properdocs (Python 3.10) +properdocs, version 1.6.5 from /path/to/properdocs (Python 3.13) ``` -## Maintenance team +## Version 1.6.5 (2026-03-15) -The current and past members of the ProperDocs team. +This is the first version of ProperDocs 🎉 + +These are the changes compared to MkDocs 1.6.1: + +* The name is changed from "ProperDocs" to "MkDocs". The installation name and the executable are `properdocs` (#12) + +* Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15) + +* Pick up configuration from `properdocs.yml` configuration files, with a fallback to `mkdocs.yml` (#27) + +* Remove all built-in themes - there is no longer any theme installed by default (#24) + +* Fix livereload not being enabled by default for `mkdocs serve` - since `click>8.2.1` (#14) + +* Allow plugins to declare their support of ProperDocs and show a warning message in case they're being run from MkDocs (#21) + +* Drop support for Python 3.8, officially support Python 3.14 (#17) + +And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...1.6.5). + +--- + +## Past releases of MkDocs + +Thanks to all the past maintainers of MkDocs! * [@tomchristie](https://github.com/tomchristie/) * [@d0ugal](https://github.com/d0ugal/) @@ -27,6 +51,8 @@ The current and past members of the ProperDocs team. * [@oprypin](https://github.com/oprypin/) * [@ultrabug](https://github.com/ultrabug/) +The versions below are versions of MkDocs, just for reference. + ## Version 1.6.1 (2024-08-30) ### Fixed diff --git a/packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/__init__.py b/packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/__init__.py index bb64aa47..f3df7f04 100644 --- a/packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/__init__.py +++ b/packages/properdocs-theme-mkdocs/properdocs_theme_mkdocs/__init__.py @@ -1 +1 @@ -__version__ = '1.6.1' +__version__ = '1.6.5' diff --git a/packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/__init__.py b/packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/__init__.py index bb64aa47..f3df7f04 100644 --- a/packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/__init__.py +++ b/packages/properdocs-theme-readthedocs/properdocs_theme_readthedocs/__init__.py @@ -1 +1 @@ -__version__ = '1.6.1' +__version__ = '1.6.5' diff --git a/properdocs/__init__.py b/properdocs/__init__.py index 7652a394..70d83859 100644 --- a/properdocs/__init__.py +++ b/properdocs/__init__.py @@ -2,4 +2,4 @@ # For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/ -__version__ = '1.6.1' +__version__ = '1.6.5' diff --git a/properdocs/replacement_warning.py b/properdocs/replacement_warning.py index 29eb6231..dda0204a 100644 --- a/properdocs/replacement_warning.py +++ b/properdocs/replacement_warning.py @@ -31,7 +31,7 @@ To avoid these risks, switch to *ProperDocs*, a continuation of MkDocs 1.x and a drop-in replacement that supports your current MkDocs setup. Simply install it with `pip install properdocs` and build your site with `properdocs build` instead of the MkDocs equivalents. -For more info visit https://github.com/ProperDocs/properdocs/discussions/123 and https://properdocs.org/ +For more info visit https://github.com/ProperDocs/properdocs/discussions/456 and https://properdocs.org/ (This warning was initiated by one of the plugins that you depend on.) From 35b4568e0b96fa29a9a7b333508bd265dfef74ab Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:11:31 +0100 Subject: [PATCH 2/5] Update docs/about/release-notes.md Co-authored-by: Andre_601 <11576465+Andre601@users.noreply.github.com> --- docs/about/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index 1f950a60..72427fc1 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -23,7 +23,7 @@ This is the first version of ProperDocs 🎉 These are the changes compared to MkDocs 1.6.1: -* The name is changed from "ProperDocs" to "MkDocs". The installation name and the executable are `properdocs` (#12) +* The name is changed from "MkDocs" to "ProperDocs". The installation name and the executable are `properdocs` (#12) * Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15) From 3ba9c91a79fc5c085b41e6d290e007303162ebb4 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:31:44 +0100 Subject: [PATCH 3/5] Update discussion link to the real one --- properdocs/replacement_warning.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/properdocs/replacement_warning.py b/properdocs/replacement_warning.py index dda0204a..30a42236 100644 --- a/properdocs/replacement_warning.py +++ b/properdocs/replacement_warning.py @@ -31,7 +31,7 @@ To avoid these risks, switch to *ProperDocs*, a continuation of MkDocs 1.x and a drop-in replacement that supports your current MkDocs setup. Simply install it with `pip install properdocs` and build your site with `properdocs build` instead of the MkDocs equivalents. -For more info visit https://github.com/ProperDocs/properdocs/discussions/456 and https://properdocs.org/ +For more info visit https://github.com/ProperDocs/properdocs/discussions/33 and https://properdocs.org/ (This warning was initiated by one of the plugins that you depend on.) From a33d0bf8ca8fa5ec340478f597315ce6fc5d1d57 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:53:37 +0100 Subject: [PATCH 4/5] Fix lint --- docs/about/release-notes.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index 72427fc1..68380038 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -23,19 +23,19 @@ This is the first version of ProperDocs 🎉 These are the changes compared to MkDocs 1.6.1: -* The name is changed from "MkDocs" to "ProperDocs". The installation name and the executable are `properdocs` (#12) +* The name is changed from "MkDocs" to "ProperDocs". The installation name and the executable are `properdocs` (#12) -* Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15) +* Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15) -* Pick up configuration from `properdocs.yml` configuration files, with a fallback to `mkdocs.yml` (#27) +* Pick up configuration from `properdocs.yml` configuration files, with a fallback to `mkdocs.yml` (#27) -* Remove all built-in themes - there is no longer any theme installed by default (#24) +* Remove all built-in themes - there is no longer any theme installed by default (#24) -* Fix livereload not being enabled by default for `mkdocs serve` - since `click>8.2.1` (#14) +* Fix livereload not being enabled by default for `mkdocs serve` - since `click>8.2.1` (#14) -* Allow plugins to declare their support of ProperDocs and show a warning message in case they're being run from MkDocs (#21) +* Allow plugins to declare their support of ProperDocs and show a warning message in case they're being run from MkDocs (#21) -* Drop support for Python 3.8, officially support Python 3.14 (#17) +* Drop support for Python 3.8, officially support Python 3.14 (#17) And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...1.6.5). From 4531a972085a0907c7318acbd32e1c2c471b941a Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 16 Mar 2026 00:57:30 +0100 Subject: [PATCH 5/5] Establish tags to start with `v` --- docs/about/release-notes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index 68380038..48fb63b1 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -37,7 +37,7 @@ These are the changes compared to MkDocs 1.6.1: * Drop support for Python 3.8, officially support Python 3.14 (#17) -And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...1.6.5). +And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...v1.6.5). ---